com.starteam
Class Folder.Status

java.lang.Object
  com.starteam.EnumeratedValue
      com.starteam.Folder.Status

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

Folder

public static final class Folder.Status
extends EnumeratedValue

The status of this folder; a value of the Status Property

See Also:

Serialized Form

Field Summary

static Folder.Status[]	ALL All legal status values
static Folder.Status	CURRENT The working folder on disk is current w.r.t.
static Folder.Status	MISSING The Folder in the repository (and any File content) is missing on disk
static Folder.Status	NEW This folder is new on disk, and has not been added to the repository

Method Summary

boolean	equals(java.lang.Object o) Compares this object with the Object o
static Folder.Status	fromID(int id) Gets the Status value corresponding to the given ID.
static Folder.Status	fromValue(EnumeratedValue value) Gets the Status value corresponding to the given EnumeratedValue.
int	getCode() Return the enum code for this object.
java.lang.String	getDisplayName() Returns the display name of the Status.
int	getID() The ID of the corresponding EnumeratedValue, as defined in StatusProperty.
java.lang.String	getName() Returns a name for the status
int	hashCode() returns a hashCode for this instance
java.lang.String	toString() Returns the name of this Status instance

Methods inherited from class com.starteam.EnumeratedValue

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

CURRENT

public static final Folder.Status CURRENT

The working folder on disk is current w.r.t. the repository

MISSING

public static final Folder.Status MISSING

The Folder in the repository (and any File content) is missing on disk

NEW

public static final Folder.Status NEW

This folder is new on disk, and has not been added to the repository

ALL

public static final Folder.Status[] ALL

All legal status values

Method Detail

getName

public java.lang.String getName()

Returns a name for the status

Returns:

a name for the status

getDisplayName

public java.lang.String getDisplayName()

Returns the display name of the Status.

Overrides:

getDisplayName in class EnumeratedValue

Returns:

the display name of this Status

getID

public int getID()

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

Returns:

The ID of this Status value.

See Also:

Folder.Type.StatusProperty.NAME

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 Folder.Status fromValue(EnumeratedValue value)

Gets the Status value corresponding to the given EnumeratedValue.

Parameters:

value - One of the EnumeratedValues of a StatusProperty.

Returns:

The corresponding Status value, or null.

fromID

public static Folder.Status fromID(int id)

Gets the Status value corresponding to the given ID.

Parameters:

id - A Status ID.

Returns:

The corresponding Status value, or null.

equals

public boolean equals(java.lang.Object o)

Compares this object with the Object o

Overrides:

equals in class EnumeratedValue

Parameters:

o - the Object to compare for equality

Returns:

true if the two objects are identical

hashCode

public int hashCode()

returns a hashCode for this instance

Overrides:

hashCode in class EnumeratedValue

Returns:

a hashCode for this instance

toString

public java.lang.String toString()

Returns the name of this Status instance

Overrides:

toString in class EnumeratedValue

Returns:

the name of this Status instance