com.starbase.starteam
Class Status

java.lang.Object
  |
  +--com.starbase.starteam.Status

public class Status

extends java.lang.Object

Represents the status of a working file relative to its corresponding file in the repository.

See Also:

File.getStatus()

Field Summary

static int	CURRENT A value of CURRENT means that the file on disk is the same as the most recent version of the file in the repository.
static int	MERGE A value of MERGE means that the file on disk have been modified from a non-tip version of the file in the repository.
static int	MISSING A value of MISSING means that the file does not exist on the local disk.
static int	MODIFIED A value of MODIFIED means that the latest version of the file from the repository has been checked out to disk but that the local file has subsequently been modified.
static int	NEW A value of NEW means that there is not file in the repository corresponding to the local file on disk.
static int	OUTOFDATE A value of OUTOFDATE means that the file on disk is unmodified from a non-tip version of the file in the repository.
static int	UNKNOWN A value of UNKNOWN means that there is no information available about what version of the file was ever checked out to the location on disk.

Method Summary

static java.lang.String

name(int statusValue) Returns a display name for the status represented by the specified code.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CURRENT

public static final int CURRENT

A value of CURRENT means that the file on disk is the same as the most recent version of the file in the repository.

See Also:

Constant Field Values

MERGE

public static final int MERGE

A value of MERGE means that the file on disk have been modified from a non-tip version of the file in the repository. This indicates that the local changes should be merged with the changes found on the server before checking the file back in.

See Also:

Constant Field Values

MISSING

public static final int MISSING

A value of MISSING means that the file does not exist on the local disk.

See Also:

Constant Field Values

MODIFIED

public static final int MODIFIED

A value of MODIFIED means that the latest version of the file from the repository has been checked out to disk but that the local file has subsequently been modified.

See Also:

Constant Field Values

OUTOFDATE

public static final int OUTOFDATE

A value of OUTOFDATE means that the file on disk is unmodified from a non-tip version of the file in the repository.

See Also:

Constant Field Values

NEW

public static final int NEW

A value of NEW means that there is not file in the repository corresponding to the local file on disk.

See Also:

Constant Field Values

UNKNOWN

public static final int UNKNOWN

A value of UNKNOWN means that there is no information available about what version of the file was ever checked out to the location on disk. You can attempt to provide this missing information using the File.updateStatus method.

See Also:

File.updateStatus, Constant Field Values

Method Detail

name

public static java.lang.String name(int statusValue)

Returns a display name for the status represented by the specified code. If the statusValue is not one of the specified constants in this class then an Exception will be thrown.

Parameters:

statusValue - the status value for which a display name is to be returned

Returns:

a display name for the status value.