com.starteam
Class Label.Scope

java.lang.Object
  com.starteam.Label.Scope

Enclosing class:

Label

public static final class Label.Scope
extends java.lang.Object

When applying a label to a folder, the scope of the operation

Field Summary

static Label.Scope[]	ALL All legal scopes
static Label.Scope	ITEM_AND_CONTENTS When applying a label to a folder you can specify the scope of the operation.
static Label.Scope	ITEM_ONLY When applying a label to a folder you can specify the scope of the operation.
static Label.Scope	ITEM_TREE When applying a label to a folder you can specify the scope of the operation.

Method Summary

boolean	equals(java.lang.Object o) Compare two scopes for equality
static Label.Scope	fromID(int id) Gets the Scope value corresponding to the given ID.
int	getID() The ID of the corresponding Scope.
java.lang.String	getName() Returns a user friendly name for the scope
int	hashCode() Returns a hashCode for this instance

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

ITEM_ONLY

public static final Label.Scope ITEM_ONLY

When applying a label to a folder you can specify the scope of the operation. This option applies the label to only the folder.

ITEM_AND_CONTENTS

public static final Label.Scope ITEM_AND_CONTENTS

When applying a label to a folder you can specify the scope of the operation. This option applies the label to the folder and its immediate contents.

ITEM_TREE

public static final Label.Scope ITEM_TREE

When applying a label to a folder you can specify the scope of the operation. This option applies the label to the folder and subfolder and all the items they contain.

ALL

public static final Label.Scope[] ALL

All legal scopes

Method Detail

getName

public java.lang.String getName()

Returns a user friendly name for the scope

Returns:

a user friendly name for the scope

getID

public int getID()

The ID of the corresponding Scope.

Returns:

The ID of this Scope value.

fromID

public static Label.Scope fromID(int id)

Gets the Scope value corresponding to the given ID.

Parameters:

id - A Scope ID.

Returns:

The corresponding Scope value, or null.

equals

public boolean equals(java.lang.Object o)

Compare two scopes for equality

Overrides:

equals in class java.lang.Object

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 java.lang.Object

Returns:

a hashCode for this instance