com.yahoo.wiki.webservice.data.config.names

Enum WikiApiDimensionConfigInfo

java.lang.Object

java.lang.Enum<WikiApiDimensionConfigInfo>

com.yahoo.wiki.webservice.data.config.names.WikiApiDimensionConfigInfo

All Implemented Interfaces:

DimensionName, Serializable, Comparable<WikiApiDimensionConfigInfo>

public enum WikiApiDimensionConfigInfo
extends Enum<WikiApiDimensionConfigInfo>
implements DimensionName

Hold all the Wikipedia API dimension names.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHANNEL
CITY_NAME
COMMENT
COUNTRY_ISO_CODE
COUNTRY_NAME
IS_ANONYMOUS
IS_MINOR
IS_NEW
IS_ROBOT
IS_UNPATROLLED
METRO_CODE
NAMESPACE
PAGE
REGION_ISO_CODE
REGION_NAME
USER

Method Summary

Modifier and Type	Method and Description
String	asName() View the dimension name.
String	getCategory()
String	getDescription()
String	getLongName()
static WikiApiDimensionConfigInfo	valueOf(String name) Returns the enum constant of this type with the specified name.
static WikiApiDimensionConfigInfo[]	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

COMMENT

public static final WikiApiDimensionConfigInfo COMMENT

COUNTRY_ISO_CODE

public static final WikiApiDimensionConfigInfo COUNTRY_ISO_CODE

REGION_ISO_CODE

public static final WikiApiDimensionConfigInfo REGION_ISO_CODE

PAGE

public static final WikiApiDimensionConfigInfo PAGE

USER

public static final WikiApiDimensionConfigInfo USER

IS_UNPATROLLED

public static final WikiApiDimensionConfigInfo IS_UNPATROLLED

IS_NEW

public static final WikiApiDimensionConfigInfo IS_NEW

IS_ROBOT

public static final WikiApiDimensionConfigInfo IS_ROBOT

IS_ANONYMOUS

public static final WikiApiDimensionConfigInfo IS_ANONYMOUS

IS_MINOR

public static final WikiApiDimensionConfigInfo IS_MINOR

NAMESPACE

public static final WikiApiDimensionConfigInfo NAMESPACE

CHANNEL

public static final WikiApiDimensionConfigInfo CHANNEL

COUNTRY_NAME

public static final WikiApiDimensionConfigInfo COUNTRY_NAME

REGION_NAME

public static final WikiApiDimensionConfigInfo REGION_NAME

METRO_CODE

public static final WikiApiDimensionConfigInfo METRO_CODE

CITY_NAME

public static final WikiApiDimensionConfigInfo CITY_NAME

Method Detail

values

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

Returns:

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

valueOf

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

asName

public String asName()

View the dimension name.

Specified by:

asName in interface DimensionName

Returns:

The camelCase version of the dimension.

getDescription

public String getDescription()

getLongName

public String getLongName()

getCategory

public String getCategory()