Package net.solarnetwork.domain.datum

Enum Class ObjectDatumKind

java.lang.Object

java.lang.Enum<ObjectDatumKind>

net.solarnetwork.domain.datum.ObjectDatumKind

All Implemented Interfaces:

Serializable, Comparable<ObjectDatumKind>, Constable

public enum ObjectDatumKind
extends Enum<ObjectDatumKind>

A datum object kind enumeration.

Since:

1.72

Version:

1.0

Author:

matt

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Location	Location datum, with location ID and source ID.
Node	Node datum, with node ID and source ID.

Method Summary

Modifier and Type	Method	Description
static ObjectDatumKind	forKey(String key)	Get an enum instance for a key value.
char	getKey()	Get the key.
static ObjectDatumKind	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ObjectDatumKind[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

Node

public static final ObjectDatumKind Node

Node datum, with node ID and source ID.

Location

public static final ObjectDatumKind Location

Location datum, with location ID and source ID.

Method Details

values

public static ObjectDatumKind[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ObjectDatumKind valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getKey

public char getKey()

Get the key.

Returns:

the key

forKey

public static ObjectDatumKind forKey(String key)

Get an enum instance for a key value.

Parameters:

key - the key value

Returns:

the enum

Throws:

IllegalArgumentException - if key is not supported