com.yahoo.wiki.webservice.data.config.dimension

Enum WikiDimensionField

java.lang.Object

java.lang.Enum<WikiDimensionField>

com.yahoo.wiki.webservice.data.config.dimension.WikiDimensionField

All Implemented Interfaces:

DimensionField, Serializable, Comparable<WikiDimensionField>

public enum WikiDimensionField
extends Enum<WikiDimensionField>
implements DimensionField

DimensionField enum.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DESC
ID

Method Summary

Modifier and Type	Method and Description
String	getDescription() The description for the dimension field.
String	getName() The name of the dimension field.
String	toString()
static WikiDimensionField	valueOf(String name) Returns the enum constant of this type with the specified name.
static WikiDimensionField[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ID

public static final WikiDimensionField ID

DESC

public static final WikiDimensionField DESC

Method Detail

values

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

Returns:

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

valueOf

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

getName

public String getName()

Description copied from interface: DimensionField

The name of the dimension field.

Specified by:

getName in interface DimensionField

Returns:

field name

getDescription

public String getDescription()

Description copied from interface: DimensionField

The description for the dimension field.

Specified by:

getDescription in interface DimensionField

Returns:

the description

toString

public String toString()

Overrides:

toString in class Enum<WikiDimensionField>