com.jamasoftware.contour.service.dto

Enum ExtDocumentTreeNode.TreeNodeKey

java.lang.Object

java.lang.Enum<ExtDocumentTreeNode.TreeNodeKey>

com.jamasoftware.contour.service.dto.ExtDocumentTreeNode.TreeNodeKey

All Implemented Interfaces:

Serializable, Comparable<ExtDocumentTreeNode.TreeNodeKey>

Enclosing class:

ExtDocumentTreeNode

public static enum ExtDocumentTreeNode.TreeNodeKey
extends Enum<ExtDocumentTreeNode.TreeNodeKey>

Enumeration of the EXT tree node keys used for this application. Keys are created with ExtDocumentTreeNode.buildTreeNodeId(TreeNodeKey, Object...), which concatenates a getKey() with ExtDocumentTreeNode.TREE_KEY_SEPARATOR, followed by an id.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL_SYNC_PROJECT
BASELINE
BASELINE_GROUP
BASELINE_PROJECT
DISTRIBUTION_GROUP_ROOT
DOCUMENT
DOCUMENT_TYPE
GROUP
MODULE_TREE_ORGANIZATION_ROOT
NOTIFICATION_GROUP_ROOT
ORGANIZATION
OUT_OF_SYNC_PROJECT
PROJECT
RECENTLY_VIEWED_PROJECT
RECENTLY_VIEWED_PROJECT_GROUP
RELATIONSHIP_DOCUMENT
RELATIONSHIP_DOCUMENT_TYPE
RELEASE
RELEASE_DOCUMENT
RELEASE_TREE_PROJECT
RELEASE_TYPE
TEST_CYCLE
TEST_PLAN
TEST_PROJECT
TEST_RUN
TEST_SET
USER

Method Summary

Methods

Modifier and Type	Method and Description
char	getKey() Obtains the unique character key for this ExtDocumentTreeNode.TreeNodeKey
Integer	getScopeId()
boolean	matchesNodeId(String nodeId)
static ExtDocumentTreeNode.TreeNodeKey	obtainKey(char key) Finds a matching ExtDocumentTreeNode.TreeNodeKey for the given key.
static ExtDocumentTreeNode.TreeNodeKey	obtainKey(String nodeIdString) Finds a matching ExtDocumentTreeNode.TreeNodeKey for the node id string (such as a-5, or p-12, etc).
static ExtDocumentTreeNode.TreeNodeKey	obtainKeyForScope(Integer scope, ExtDocumentTreeNode.TreeNodeCategory category)
static ExtDocumentTreeNode.TreeNodeKey	valueOf(String name) Returns the enum constant of this type with the specified name.
static ExtDocumentTreeNode.TreeNodeKey[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ORGANIZATION

public static final ExtDocumentTreeNode.TreeNodeKey ORGANIZATION

PROJECT

public static final ExtDocumentTreeNode.TreeNodeKey PROJECT

DOCUMENT_TYPE

public static final ExtDocumentTreeNode.TreeNodeKey DOCUMENT_TYPE

GROUP

public static final ExtDocumentTreeNode.TreeNodeKey GROUP

DOCUMENT

public static final ExtDocumentTreeNode.TreeNodeKey DOCUMENT

RELATIONSHIP_DOCUMENT

public static final ExtDocumentTreeNode.TreeNodeKey RELATIONSHIP_DOCUMENT

USER

public static final ExtDocumentTreeNode.TreeNodeKey USER

BASELINE_PROJECT

public static final ExtDocumentTreeNode.TreeNodeKey BASELINE_PROJECT

BASELINE_GROUP

public static final ExtDocumentTreeNode.TreeNodeKey BASELINE_GROUP

TEST_PROJECT

public static final ExtDocumentTreeNode.TreeNodeKey TEST_PROJECT

TEST_PLAN

public static final ExtDocumentTreeNode.TreeNodeKey TEST_PLAN

TEST_SET

public static final ExtDocumentTreeNode.TreeNodeKey TEST_SET

TEST_CYCLE

public static final ExtDocumentTreeNode.TreeNodeKey TEST_CYCLE

TEST_RUN

public static final ExtDocumentTreeNode.TreeNodeKey TEST_RUN

BASELINE

public static final ExtDocumentTreeNode.TreeNodeKey BASELINE

DISTRIBUTION_GROUP_ROOT

public static final ExtDocumentTreeNode.TreeNodeKey DISTRIBUTION_GROUP_ROOT

NOTIFICATION_GROUP_ROOT

public static final ExtDocumentTreeNode.TreeNodeKey NOTIFICATION_GROUP_ROOT

MODULE_TREE_ORGANIZATION_ROOT

public static final ExtDocumentTreeNode.TreeNodeKey MODULE_TREE_ORGANIZATION_ROOT

RELEASE_TREE_PROJECT

public static final ExtDocumentTreeNode.TreeNodeKey RELEASE_TREE_PROJECT

RELEASE

public static final ExtDocumentTreeNode.TreeNodeKey RELEASE

RELEASE_TYPE

public static final ExtDocumentTreeNode.TreeNodeKey RELEASE_TYPE

RELEASE_DOCUMENT

public static final ExtDocumentTreeNode.TreeNodeKey RELEASE_DOCUMENT

RELATIONSHIP_DOCUMENT_TYPE

public static final ExtDocumentTreeNode.TreeNodeKey RELATIONSHIP_DOCUMENT_TYPE

ALL_SYNC_PROJECT

public static final ExtDocumentTreeNode.TreeNodeKey ALL_SYNC_PROJECT

OUT_OF_SYNC_PROJECT

public static final ExtDocumentTreeNode.TreeNodeKey OUT_OF_SYNC_PROJECT

RECENTLY_VIEWED_PROJECT_GROUP

public static final ExtDocumentTreeNode.TreeNodeKey RECENTLY_VIEWED_PROJECT_GROUP

RECENTLY_VIEWED_PROJECT

public static final ExtDocumentTreeNode.TreeNodeKey RECENTLY_VIEWED_PROJECT

Method Detail

values

public static ExtDocumentTreeNode.TreeNodeKey[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ExtDocumentTreeNode.TreeNodeKey c : ExtDocumentTreeNode.TreeNodeKey.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ExtDocumentTreeNode.TreeNodeKey valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getKey

public char getKey()

Obtains the unique character key for this ExtDocumentTreeNode.TreeNodeKey

Returns:

The character key

getScopeId

public Integer getScopeId()

Returns:

The Scope integer that applies to this TreeNodeKey, if one is mapped.

matchesNodeId

public boolean matchesNodeId(String nodeId)

obtainKey

public static ExtDocumentTreeNode.TreeNodeKey obtainKey(char key)

Finds a matching ExtDocumentTreeNode.TreeNodeKey for the given key.

Parameters:

key - A ExtDocumentTreeNode.TreeNodeKey key

Returns:

A matching ExtDocumentTreeNode.TreeNodeKey, or null

obtainKey

public static ExtDocumentTreeNode.TreeNodeKey obtainKey(String nodeIdString)

Finds a matching ExtDocumentTreeNode.TreeNodeKey for the node id string (such as a-5, or p-12, etc).

Parameters:

nodeIdString - The node id string

Returns:

A matching ExtDocumentTreeNode.TreeNodeKey, or null

obtainKeyForScope

public static ExtDocumentTreeNode.TreeNodeKey obtainKeyForScope(Integer scope,
                                                ExtDocumentTreeNode.TreeNodeCategory category)