Project: stp

com.ibm.rational.wvcm.stp
Enum StpProvider.Domain

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

public static enum StpProvider.Domain
extends Enum<StpProvider.Domain>
implements com.ibm.rational.wvcm.stpex.StpExEnumeration

The type of a subprovider.


Enum Constant Summary
CLEAR_CASE
          The ClearCase domain.
CLEAR_QUEST
          The ClearQuest domain
CMI
          The CMI domain
INVALID
          An invalid domain
NONE
          An unspecified domain
 
Method Summary
static StpProvider.Domain fromSymbol(String symbol)
          Returns the Domain object that matches a given domain-field symbol
 String toSymbol()
           
static StpProvider.Domain valueOf(String name)
          Returns the enum constant of this type with the specified name.
static StpProvider.Domain[] 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

CLEAR_CASE

public static final StpProvider.Domain CLEAR_CASE
The ClearCase domain.


CLEAR_QUEST

public static final StpProvider.Domain CLEAR_QUEST
The ClearQuest domain


CMI

public static final StpProvider.Domain CMI
The CMI domain


INVALID

public static final StpProvider.Domain INVALID
An invalid domain


NONE

public static final StpProvider.Domain NONE
An unspecified domain

Method Detail

fromSymbol

public static final StpProvider.Domain fromSymbol(String symbol)
Returns the Domain object that matches a given domain-field symbol

Parameters:
symbol - A String containing the domain-field symbol to be converted to a Domain object.
Returns:
A Domain object that matches the given symbol. Will be INVALID if no Domain object matches the given symbol.

toSymbol

public String toSymbol()
Returns:
Returns the word token to use in the domain field of a location specification for this Domain.

valueOf

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

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

Generated Thu 18-Aug-2016 11:59 AM

Copyright © IBM 2016. All rights reserved.