de.vandermeer.skb.categories.kvt

Enum ScopeKey

java.lang.Object

java.lang.Enum<ScopeKey>

de.vandermeer.skb.categories.kvt.ScopeKey

All Implemented Interfaces:

CategoryHas, CategoryIs, CategoryWithValue, HasDescription, IsKey_String, Serializable, Comparable<ScopeKey>

public enum ScopeKey
extends Enum<ScopeKey>
implements IsKey_String

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABOVE
BELOW
SELF

Field Summary

Fields inherited from interface de.vandermeer.skb.categories.CategoryWithValue

comparator

Method Summary

Modifier and Type	Method and Description
String	_value() Returns the value of an IS category.
Object	getDescription() Returns the description of an object.
String	toString()
static ScopeKey	valueOf(String name) Returns the enum constant of this type with the specified name.
static ScopeKey[]	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

Methods inherited from interface de.vandermeer.skb.categories.kvt.IsKey_String

create, create, create, key

Methods inherited from interface de.vandermeer.skb.categories.CategoryWithValue

CAT_TO_VALUE, CAT_TO_VALUESTRING, GET_VALUE, GET_VALUESTRING, toLog

Enum Constant Detail

ABOVE

public static final ScopeKey ABOVE

SELF

public static final ScopeKey SELF

BELOW

public static final ScopeKey BELOW

Method Detail

values

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

Returns:

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

valueOf

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

getDescription

public Object getDescription()

Description copied from interface: HasDescription

Returns the description of an object.

Specified by:

getDescription in interface HasDescription

Returns:

description

_value

public String _value()

Description copied from interface: CategoryWithValue

Returns the value of an IS category.

Specified by:

_value in interface CategoryWithValue

Specified by:

_value in interface IsKey_String

Returns:

value of an IS category

toString

public String toString()

Overrides:

toString in class Enum<ScopeKey>