Project: stp

com.ibm.rational.wvcm.stp
Enum StpLocation.Namespace

Object
  extended by Enum<StpLocation.Namespace>
      extended by com.ibm.rational.wvcm.stp.StpLocation.Namespace
All Implemented Interfaces:
com.ibm.rational.wvcm.stpex.StpExEnumeration, Serializable, Comparable<StpLocation.Namespace>
Enclosing interface:
StpLocation

public static enum StpLocation.Namespace
extends Enum<StpLocation.Namespace>
implements com.ibm.rational.wvcm.stpex.StpExEnumeration, Serializable

This class enumerates the namespaces that may appear in a location specification. Instances of the class are used to represent the namespace of the location represented by an StpLocation object. The Namespace maps directly to the word token used in a location specification to denote the namespace of the resource named by the location. Each resource may appear in multiple namespaces.


Enum Constant Summary
ACTION
          The user-friendly-selector-scheme Namespace for an action
ACTIVITY
          The user-friendly-selector-scheme Namespace for an activity
ATTYPE
          The user-friendly-selector-scheme Namespace for an attribute type
BASELINE
          The user-friendly-selector-scheme Namespace for a baseline
BRANCH
          The user-friendly-selector-scheme Namespace for a branch
BRTYPE
          The user-friendly-selector-scheme Namespace for a branch type
COMPONENT
          The user-friendly-selector-scheme Namespace for a component
DB_SET
          A repository-path-scheme Namespace for a ClearQuest database known variously as a profile, connection, database-set, master database, or schema repository
DBID
          A stable-selector-scheme Namespace for a ClearCase resource specified by its DBID
DEFAULT
          A special path-scheme Namespace indicating that the namespace field in the location specification was empty, which is the convention for specifying the default namespace of a repository.
DOMAINSERVER
          The user-friendly-selector-scheme Namespace for a server; e.g.
DYNAMIC_CHOICE_LIST
          The user-friendly-selector-scheme Namespace for a dynamic choice list.
ELTYPE
          The user-friendly-selector-scheme Namespace for an element type
FAST
          The special, compound namespace used in the selector scheme for specification of efficiently-accessed locations.
FIELD_DEFINITION
          The user-friendly-selector-scheme Namespace for a field definition
FILE
          The URL-path-scheme and file-path-scheme Namespace for a file URL
FOLDER
          The user-friendly-selector-scheme Namespace for a folder
FORM
          The user-friendly-selector-scheme Namespace for a form
GROUP
          The user-friendly-selector-scheme Namespace for a group
HLINK
          The user-friendly-selector-scheme Namespace for a hyperlink
HLTYPE
          The user-friendly-selector-scheme Namespace for a hyperlink type
HOOK
          The user-friendly-selector-scheme Namespace for a hook
HTTP
          The URL-path-scheme Namespace denoting a location presented in the form of an HTTP URI or URL
HTTPS
          The URL-path-scheme Namespace denoting a location presented in the form of an HTTPS URI or URL
INVALID
          A special path-scheme Namespace indicating that the namespace field of a location is unknown.
LBTYPE
          The user-friendly-selector-scheme Namespace for a label type
LEGACYSERVER
          The path-scheme for a CCRC (aka, "legacy") server
NONE
          A special path-scheme Namespace indicating that no namespace was specified in the location specification.
OID
          A stable-selector-scheme Namespace for a ClearCase resource specified by its OID
PNAME
          A special file-path-scheme namespace that forces the rest of the location to be interpreted as a ClearCase P-name, a file system pathname with an optional history-mode extension.
PNAME_IMPLIED
          A special file-path-scheme Namespace indicating a pname without an explicit PNAME prefix.
POLICY
          The user-friendly-selector-scheme Namespace for a policy
POOL
          The user-friendly-selector-scheme Namespace for a pool
PROJECT
          The user-friendly-selector-scheme Namespace for a project.
PROJECT_CONFIGURATION
          The user-friendly-selector-scheme Namespace for a project configuration
QUERY
          The user-friendly-selector-scheme Namespace for a query, chart, report, report format, or query folder.
RECORD
          The user-friendly-selector-scheme Namespace for a record, record type, attachment folder, or attachment
REGISTRY_REGION
          The user-friendly, efficient, and stable-scheme Namespace for a ClearCase registry region.
REPLICA
          The user-friendly-selector-scheme Namespace for a replica
REPLICA_UUID
          A repository-path-scheme Namespace for a ClearCase VOB specified by its replica UUID
REPO
          The special, compound namespace used in stable selector schemes.
ROLEMAP
          The user-friendly-selector-scheme Namespace for a rolemap
RPTYPE
          The user-friendly-selector-scheme Namespace for an rptype
STORAGE_LOCATION
          The user-friendly, efficient, and stable-scheme Namespace for a ClearCase storage location.
STREAM
          The user-friendly-selector-scheme Namespace for a stream
TASK
          The user-friendly, efficient, and stable-scheme Namespace for a ClearCase task.
TRTYPE
          The user-friendly-selector-scheme Namespace for a trigger type
USER
          The user-friendly-selector-scheme Namespace for a user
USER_DB
          A repository-path-scheme Namespace for a ClearQuest user database
VIEW_UUID
          A repository-path-scheme Namespace for a ClearCase view specified by its UUID
VIEWTAG
          The user-friendly, efficient, and stable-scheme Namespace for a view tag.
VOB
          A repository-path-scheme Namespace for a ClearCase VOB specified directly by tag or indirectly by an entity within the VOB.
VOB_TAG_AS_DIRECTORY
          The path-scheme Namespace for a ClearCase VOB tag, treated in some senses as a directory.
VOB_UUID
          A repository-path-scheme Namespace for a ClearCase VOB specified by its VOB family UUID.
VOBTAG
          The user-friendly, efficient, and stable-scheme Namespace for a VOB tag.
WORKSPACE
          The path-scheme Namespace for a workspace
 
Method Summary
static StpLocation.Namespace fromNamespaceField(String field)
          Finds the Namespace enumerator from the identifier used in the namespace field of a location specification.
 boolean isEscapeEncoded()
           
 boolean isExtendedNamespace()
           
 boolean isFilePathScheme()
           
 boolean isPathScheme()
           
 boolean isRepositoryPathScheme()
           
 boolean isUrlPathScheme()
           
 boolean isValid()
          Determines whether this namespace is valid (not NONE or INVALID).
 String toNamespaceField()
          Returns the word token for this Namespace in the namespace field of a location specification.
static StpLocation.Namespace valueOf(String name)
          Returns the enum constant of this type with the specified name.
static StpLocation.Namespace[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

ACTION

public static final StpLocation.Namespace ACTION
The user-friendly-selector-scheme Namespace for an action


ACTIVITY

public static final StpLocation.Namespace ACTIVITY
The user-friendly-selector-scheme Namespace for an activity


ATTYPE

public static final StpLocation.Namespace ATTYPE
The user-friendly-selector-scheme Namespace for an attribute type


BASELINE

public static final StpLocation.Namespace BASELINE
The user-friendly-selector-scheme Namespace for a baseline


BRANCH

public static final StpLocation.Namespace BRANCH
The user-friendly-selector-scheme Namespace for a branch


BRTYPE

public static final StpLocation.Namespace BRTYPE
The user-friendly-selector-scheme Namespace for a branch type


COMPONENT

public static final StpLocation.Namespace COMPONENT
The user-friendly-selector-scheme Namespace for a component


DB_SET

public static final StpLocation.Namespace DB_SET
A repository-path-scheme Namespace for a ClearQuest database known variously as a profile, connection, database-set, master database, or schema repository


DBID

public static final StpLocation.Namespace DBID
A stable-selector-scheme Namespace for a ClearCase resource specified by its DBID


DEFAULT

public static final StpLocation.Namespace DEFAULT
A special path-scheme Namespace indicating that the namespace field in the location specification was empty, which is the convention for specifying the default namespace of a repository.


DOMAINSERVER

public static final StpLocation.Namespace DOMAINSERVER
The user-friendly-selector-scheme Namespace for a server; e.g. ClearCase or ClearQuest


DYNAMIC_CHOICE_LIST

public static final StpLocation.Namespace DYNAMIC_CHOICE_LIST
The user-friendly-selector-scheme Namespace for a dynamic choice list.


ELTYPE

public static final StpLocation.Namespace ELTYPE
The user-friendly-selector-scheme Namespace for an element type


FAST

public static final StpLocation.Namespace FAST
The special, compound namespace used in the selector scheme for specification of efficiently-accessed locations. To fully specify the efficient selector scheme namespace, a resource-type string must follow the FAST word token in the location specification.


FIELD_DEFINITION

public static final StpLocation.Namespace FIELD_DEFINITION
The user-friendly-selector-scheme Namespace for a field definition


FILE

public static final StpLocation.Namespace FILE
The URL-path-scheme and file-path-scheme Namespace for a file URL


FOLDER

public static final StpLocation.Namespace FOLDER
The user-friendly-selector-scheme Namespace for a folder


FORM

public static final StpLocation.Namespace FORM
The user-friendly-selector-scheme Namespace for a form


GROUP

public static final StpLocation.Namespace GROUP
The user-friendly-selector-scheme Namespace for a group


HLINK

public static final StpLocation.Namespace HLINK
The user-friendly-selector-scheme Namespace for a hyperlink


HLTYPE

public static final StpLocation.Namespace HLTYPE
The user-friendly-selector-scheme Namespace for a hyperlink type


HOOK

public static final StpLocation.Namespace HOOK
The user-friendly-selector-scheme Namespace for a hook


HTTP

public static final StpLocation.Namespace HTTP
The URL-path-scheme Namespace denoting a location presented in the form of an HTTP URI or URL


HTTPS

public static final StpLocation.Namespace HTTPS
The URL-path-scheme Namespace denoting a location presented in the form of an HTTPS URI or URL


INVALID

public static final StpLocation.Namespace INVALID
A special path-scheme Namespace indicating that the namespace field of a location is unknown.


LBTYPE

public static final StpLocation.Namespace LBTYPE
The user-friendly-selector-scheme Namespace for a label type


LEGACYSERVER

public static final StpLocation.Namespace LEGACYSERVER
The path-scheme for a CCRC (aka, "legacy") server


NONE

public static final StpLocation.Namespace NONE
A special path-scheme Namespace indicating that no namespace was specified in the location specification.


OID

public static final StpLocation.Namespace OID
A stable-selector-scheme Namespace for a ClearCase resource specified by its OID


PNAME

public static final StpLocation.Namespace PNAME
A special file-path-scheme namespace that forces the rest of the location to be interpreted as a ClearCase P-name, a file system pathname with an optional history-mode extension.


PNAME_IMPLIED

public static final StpLocation.Namespace PNAME_IMPLIED
A special file-path-scheme Namespace indicating a pname without an explicit PNAME prefix. Locations in the PNAME_IMPLIED namespace display simply as P-names.


POLICY

public static final StpLocation.Namespace POLICY
The user-friendly-selector-scheme Namespace for a policy


POOL

public static final StpLocation.Namespace POOL
The user-friendly-selector-scheme Namespace for a pool


PROJECT

public static final StpLocation.Namespace PROJECT
The user-friendly-selector-scheme Namespace for a project.


PROJECT_CONFIGURATION

public static final StpLocation.Namespace PROJECT_CONFIGURATION
The user-friendly-selector-scheme Namespace for a project configuration


QUERY

public static final StpLocation.Namespace QUERY
The user-friendly-selector-scheme Namespace for a query, chart, report, report format, or query folder.


RECORD

public static final StpLocation.Namespace RECORD
The user-friendly-selector-scheme Namespace for a record, record type, attachment folder, or attachment


REGISTRY_REGION

public static final StpLocation.Namespace REGISTRY_REGION
The user-friendly, efficient, and stable-scheme Namespace for a ClearCase registry region.


REPLICA

public static final StpLocation.Namespace REPLICA
The user-friendly-selector-scheme Namespace for a replica


REPLICA_UUID

public static final StpLocation.Namespace REPLICA_UUID
A repository-path-scheme Namespace for a ClearCase VOB specified by its replica UUID


REPO

public static final StpLocation.Namespace REPO
The special, compound namespace used in stable selector schemes. To fully specify the stable selector scheme namespace, a resource-type string must follow the REPO word token in the location specification.


ROLEMAP

public static final StpLocation.Namespace ROLEMAP
The user-friendly-selector-scheme Namespace for a rolemap


RPTYPE

public static final StpLocation.Namespace RPTYPE
The user-friendly-selector-scheme Namespace for an rptype


STORAGE_LOCATION

public static final StpLocation.Namespace STORAGE_LOCATION
The user-friendly, efficient, and stable-scheme Namespace for a ClearCase storage location.


STREAM

public static final StpLocation.Namespace STREAM
The user-friendly-selector-scheme Namespace for a stream


TASK

public static final StpLocation.Namespace TASK
The user-friendly, efficient, and stable-scheme Namespace for a ClearCase task.


TRTYPE

public static final StpLocation.Namespace TRTYPE
The user-friendly-selector-scheme Namespace for a trigger type


USER

public static final StpLocation.Namespace USER
The user-friendly-selector-scheme Namespace for a user


USER_DB

public static final StpLocation.Namespace USER_DB
A repository-path-scheme Namespace for a ClearQuest user database


VIEW_UUID

public static final StpLocation.Namespace VIEW_UUID
A repository-path-scheme Namespace for a ClearCase view specified by its UUID


VIEWTAG

public static final StpLocation.Namespace VIEWTAG
The user-friendly, efficient, and stable-scheme Namespace for a view tag.


VOB

public static final StpLocation.Namespace VOB
A repository-path-scheme Namespace for a ClearCase VOB specified directly by tag or indirectly by an entity within the VOB.


VOB_TAG_AS_DIRECTORY

public static final StpLocation.Namespace VOB_TAG_AS_DIRECTORY
The path-scheme Namespace for a ClearCase VOB tag, treated in some senses as a directory. Note: This namespace is an implementation detail of the server, which unfortunately must be exposed to clients. It is not intended that clients should attempt to create resources within this namespace. Undefined behavior is guaranteed if clients attempt this. It is not expected that the server will return resources within this namespace.


VOB_UUID

public static final StpLocation.Namespace VOB_UUID
A repository-path-scheme Namespace for a ClearCase VOB specified by its VOB family UUID.


VOBTAG

public static final StpLocation.Namespace VOBTAG
The user-friendly, efficient, and stable-scheme Namespace for a VOB tag.


WORKSPACE

public static final StpLocation.Namespace WORKSPACE
The path-scheme Namespace for a workspace

Method Detail

fromNamespaceField

public static final StpLocation.Namespace fromNamespaceField(String field)
Finds the Namespace enumerator from the identifier used in the namespace field of a location specification.

Parameters:
field - The word token as it appears in a location namespace field.
Returns:
The Namespace that the namespace field identifier denotes. Namespace.INVALID is returned if no Namespace enumerator matches the symbol exactly.

isEscapeEncoded

public boolean isEscapeEncoded()
Returns:
Whether or not the name field of a location specification prefixed by this namespace should be %-escaped encoded.

isExtendedNamespace

public boolean isExtendedNamespace()
Returns:
true iff this namespace requires additional segments to complete its specification.

isFilePathScheme

public boolean isFilePathScheme()
Returns:
true iff this namespace prefixes a file path scheme.

isPathScheme

public boolean isPathScheme()
Returns:
true iff this namespace prefixes a path scheme

isRepositoryPathScheme

public boolean isRepositoryPathScheme()
Returns:
true iff this namespace prefixes a path scheme selector for the name of a repository (or repository-like entity not in a repository). Said path is the value of the Repo field rather than the Name field of an StpLocation.

isUrlPathScheme

public boolean isUrlPathScheme()
Returns:
true iff this namespace prefixes a path scheme selector expressed as a URL or URI. The complete URI, including this prefix is contained wholly within the Name field of the StpLocation

isValid

public boolean isValid()
Determines whether this namespace is valid (not NONE or INVALID).

Returns:
true if this Namespace represents a valid namespace; false otherwise.

toNamespaceField

public String toNamespaceField()
Returns the word token for this Namespace in the namespace field of a location specification.

Returns:
A String containing the namespace field value that denotes this Namespace.

valueOf

public static StpLocation.Namespace 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

values

public static StpLocation.Namespace[] 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 (StpLocation.Namespace c : StpLocation.Namespace.values())
    System.out.println(c);

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

Generated Tue 25-Jul-2017 08:41 PM

Copyright © IBM 2017. All rights reserved.