com.starteam
Class File.Status

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

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

File

public static final class File.Status
extends EnumeratedValue

The current status of the file.

See Also:

File.Type.StatusProperty, File.Type.PropertyCollection.STATUS, Serialized Form

Field Summary

static File.Status[]	ALL All legal Status values
static File.Status	CURRENT The working file on disk is CURRENT w.r.t.
static File.Status	MERGE The working file on disk needs to be merged with the file in the repository
static File.Status	MISSING There is a file in the repository that is missing on disk
static File.Status	MODIFIED The working file on disk has been modified
static File.Status	NEW The working file on disk does not exist in the repository
static File.Status	OUT_OF_DATE The file in the repository has newer content than the working file on disk
static File.Status	UNKNOWN The state of the file on disk w.r.t.

Method Summary

boolean	equals(java.lang.Object o) Compares this Status instance with the Object o
static File.Status	fromID(int id) Gets the Status value corresponding to the given ID.
static File.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 a String name for this Status
int	getID() The ID of the corresponding EnumeratedValue, as defined in StatusProperty.
java.lang.String	getName() Returns a String name for this Status
int	hashCode() Returns a hashCode for this Status 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 File.Status CURRENT

The working file on disk is CURRENT w.r.t. the repository

MERGE

public static final File.Status MERGE

The working file on disk needs to be merged with the file in the repository

MISSING

public static final File.Status MISSING

There is a file in the repository that is missing on disk

MODIFIED

public static final File.Status MODIFIED

The working file on disk has been modified

NEW

public static final File.Status NEW

The working file on disk does not exist in the repository

OUT_OF_DATE

public static final File.Status OUT_OF_DATE

The file in the repository has newer content than the working file on disk

UNKNOWN

public static final File.Status UNKNOWN

The state of the file on disk w.r.t. the content in the repository cannot be determined

ALL

public static final File.Status[] ALL

All legal Status values

Method Detail

getName

public java.lang.String getName()

Returns a String name for this Status

Returns:

a String name for this Status

getDisplayName

public java.lang.String getDisplayName()

Returns a String name for this Status

Overrides:

getDisplayName in class EnumeratedValue

Returns:

a String name for 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:

File.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 File.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 File.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 Status instance with the Object o

Overrides:

equals in class EnumeratedValue

Parameters:

o - the Object to compare with for equality

Returns:

true if o is identical to this Status

hashCode

public int hashCode()

Returns a hashCode for this Status instance

Overrides:

hashCode in class EnumeratedValue

Returns:

a hashCode for this Status 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