com.starteam
Class File.KeywordFlag

java.lang.Object
  com.starteam.EnumeratedValue
      com.starteam.File.KeywordFlag

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

File

public static final class File.KeywordFlag
extends EnumeratedValue

File keyword flag.

See Also:

Serialized Form

Field Summary

static File.KeywordFlag[]	ALL All supported keyword flag values.
static File.KeywordFlag	ALWAYS_EXPAND Always Expand Keywords.
static File.KeywordFlag	NEVER_EXPAND Never expand Keywords.
static File.KeywordFlag	PROJECT_SETTINGS Use project Settings.

Method Summary

boolean	equals(java.lang.Object o) Compares this KeywordFlag instance with the object O
static File.KeywordFlag	fromID(int id) Gets the KeywordFlag value corresponding to the given ID.
static File.KeywordFlag	fromValue(EnumeratedValue value) Gets the KeywordFlag value corresponding to the given EnumeratedValue.
int	getCode() Return the enum code for this object.
int	getID() The ID of the corresponding EnumeratedValue, as defined in KeywordFlagProperty.
int	hashCode() Returns a hashCode for this object

Methods inherited from class com.starteam.EnumeratedValue

addChild, assignParent, copy, disable, enable, findChild, getChildValues, getDebugString, getDepthInHierarchy, getDisplayName, getDisplayNameTranslations, getInternalName, getParentValue, getSortOrder, hasChildValues, isClosedState, isDisabled, isEnabled, isEqualTo, isLeafValue, isRootValue, isSelectable, setAfter, setChildValues, setClosedState, setDisplayName, setDisplayNameTranslations, setEnabled, setInternalName, setSelectable, setSortOrder, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

PROJECT_SETTINGS

public static final File.KeywordFlag PROJECT_SETTINGS

Use project Settings.

ALWAYS_EXPAND

public static final File.KeywordFlag ALWAYS_EXPAND

Always Expand Keywords.

NEVER_EXPAND

public static final File.KeywordFlag NEVER_EXPAND

Never expand Keywords.

ALL

public static final File.KeywordFlag[] ALL

All supported keyword flag values.

Method Detail

getID

public int getID()

The ID of the corresponding EnumeratedValue, as defined in KeywordFlagProperty.

Returns:

The ID of this Keyword Flag value.

See Also:

File.Type.KeywordFlagProperty

getCode

public int getCode()

Return the enum code for this object.

Overrides:

getCode in class EnumeratedValue

Returns:

the enum code for this object.

fromValue

public static File.KeywordFlag fromValue(EnumeratedValue value)

Gets the KeywordFlag value corresponding to the given EnumeratedValue.

Parameters:

value - One of the EnumeratedValues of a KeywordFlagProperty.

Returns:

The corresponding KeywordFlag value, or null.

fromID

public static File.KeywordFlag fromID(int id)

Gets the KeywordFlag value corresponding to the given ID.

Parameters:

id - The ID of a KeywordFlag value.

Returns:

The corresponding KeywordFlag value, or null.

equals

public boolean equals(java.lang.Object o)

Compares this KeywordFlag instance with the object O

Overrides:

equals in class EnumeratedValue

Parameters:

o - the Object to compare for equality

Returns:

true if this KeywordFlag instance is the same as Object o

hashCode

public int hashCode()

Returns a hashCode for this object

Overrides:

hashCode in class EnumeratedValue

Returns:

a hashCode for this object instance