org.rhq.enterprise.server.plugins.alertOperations
Enum TokenClass

java.lang.Object
  java.lang.Enum<TokenClass>
      org.rhq.enterprise.server.plugins.alertOperations.TokenClass

All Implemented Interfaces:

Serializable, Comparable<TokenClass>

public enum TokenClass
extends Enum<TokenClass>

Class a @See{Token} can be in.

Author:

Heiko W. Rupp

Enum Constant Summary

ALERT

OPERATION

RESOURCE

TARGET_RESOURCE

TEST

Method Summary

static TokenClass	getByText(String input) Return the tokenclass that matches the input text or null if not found.
String	getDescription()
String	getText()
static TokenClass	valueOf(String name) Returns the enum constant of this type with the specified name.
static TokenClass[]	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

ALERT

public static final TokenClass ALERT

RESOURCE

public static final TokenClass RESOURCE

TARGET_RESOURCE

public static final TokenClass TARGET_RESOURCE

OPERATION

public static final TokenClass OPERATION

TEST

public static final TokenClass TEST

Method Detail

values

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

Returns:

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

valueOf

public static TokenClass 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

getText

public String getText()

getDescription

public String getDescription()

getByText

public static TokenClass getByText(String input)

Return the tokenclass that matches the input text or null if not found. The token delimiters need to be already stripped from the input

Parameters:

input - a token text like alert, which would return the ALERT token class.

Returns:

The matching token class or null if not found