Overview | Package | Class | Tree | Deprecated | Index | Help
| Compoze Software, Inc.
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.compoze.exchange
Class FlagStatus

    java.lang.Object
      com.compoze.exchange.FlagStatus

All Implemented Interfaces:
  java.io.Serializable

public class FlagStatus
extends java.lang.Object
implements java.io.Serializable

This class implements the flag status. Flag status is used to determine if a flag is set, and if so, to designate the status of a flag.

See Also:
  Serialized Form

Field Summary
`static FlagStatus` | `NO_FLAG` This value represents the 'no flag' flag status.
`static FlagStatus` | `RED_FLAG` This value represents the 'red flag' flag status.
`static int` | `STORE_VALUE_NO_FLAG` This value represents the 'no flag' store value.
`static int` | `STORE_VALUE_RED_FLAG` This value represents the 'red flag' store value.
`static int` | `STORE_VALUE_WHITE_FLAG` This value represents the 'white flag' store value.
`static FlagStatus` | `WHITE_FLAG` This value represents the 'white flag' flag status.

Method Summary
`boolean` | `equals(java.lang.Object o)` Indicates whether some other `FlagStatus` object is "equal to" this one.
`static FlagStatus` | `get(int iStoreValue)` Gets the flag by the store value.
`static java.util.List` | `getList()` Gets an unmodifiable list of flags.
`java.lang.String` | `getName()` Gets the name using the system default locale.
`java.lang.String` | `getName(java.util.Locale locale)` Gets the name using the specified locale.
`int` | `getStoreValue()` Gets the store value.
`java.lang.String` | `toString()` Returns a string representation of the object.
`java.lang.String` | `toString(java.util.Locale locale)` Returns a string representation of the object.

Methods inherited from class java.lang.Object
`clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

### STORE_VALUE_NO_FLAG

    public static final int STORE_VALUE_NO_FLAG

  This value represents the 'no flag' store value.

  See Also:
    Constant Field Values

### STORE_VALUE_WHITE_FLAG

    public static final int STORE_VALUE_WHITE_FLAG

  This value represents the 'white flag' store value.

  See Also:
    Constant Field Values

### STORE_VALUE_RED_FLAG

    public static final int STORE_VALUE_RED_FLAG

  This value represents the 'red flag' store value.

  See Also:
    Constant Field Values

### NO_FLAG

    public static final FlagStatus NO_FLAG

  This value represents the 'no flag' flag status.

### WHITE_FLAG

    public static final FlagStatus WHITE_FLAG

  This value represents the 'white flag' flag status.

### RED_FLAG

    public static final FlagStatus RED_FLAG

  This value represents the 'red flag' flag status.

Method Detail

### getStoreValue

    public int getStoreValue()

  Gets the store value.

  Returns:
    the store value for the flag status

### getName

    public java.lang.String getName()

  Gets the name using the system default locale.

  Returns:
    the name for the flag

### getName

    public java.lang.String getName(java.util.Locale locale)

  Gets the name using the specified locale. If this is a custom flag, the locale is ignored.

  Parameters:
    `locale` - the locale
  Returns:
    the name for the flag

### get

    public static FlagStatus get(int iStoreValue)

  Gets the flag by the store value.

  Parameters:
    `iStoreValue` - the store value of the flag
  Returns:
    the matching flag status or `null` if not found

### getList

    public static java.util.List getList()

  Gets an unmodifiable list of flags.

  Returns:
    the list `FlagStatus` objects (unmodifiable)

### equals

    public boolean equals(java.lang.Object o)

  Indicates whether some other `FlagStatus` object is "equal to" this one. The store value is used to determine equality.

  Returns:
    if `true`, this object is the same as the obj argument; `false` otherwise

### toString

    public java.lang.String toString()

  Returns a string representation of the object.

  Returns:
    the string representation of the object

### toString

    public java.lang.String toString(java.util.Locale locale)

  Returns a string representation of the object.

  Parameters:
    `locale` - the locale to use
  Returns:
    the string representation of the object

Overview | Package | Class | Tree | Deprecated | Index | Help
| Compoze Software, Inc.
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright ©1999-2003 Compoze Software, Inc. All rights reserved.