Package net.solarnetwork.ocpp.domain

Enum Class ReadingContext

java.lang.Object

java.lang.Enum<ReadingContext>

net.solarnetwork.ocpp.domain.ReadingContext

All Implemented Interfaces:

Serializable, Comparable<ReadingContext>, Constable, net.solarnetwork.domain.CodedValue

public enum ReadingContext
extends Enum<ReadingContext>
implements net.solarnetwork.domain.CodedValue

The context for a sampled value.

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
InterruptionBegin	Interruption begin.
InterruptionEnd	Interruption end.
Other	Other.
SampleClock	Sample clock.
SamplePeriodic	Sample periodic.
TransactionBegin	Transaction begin.
TransactionEnd	Transaction end.
Trigger	Trigger.
Unknown	Unknown.

Method Summary

Modifier and Type	Method	Description
static ReadingContext	forCode(int code)	Get an enumeration value for a code value.
int	getCode()	Get the code value.
static ReadingContext	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ReadingContext[]	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

Unknown

public static final ReadingContext Unknown

Unknown.

InterruptionBegin

public static final ReadingContext InterruptionBegin

Interruption begin.

InterruptionEnd

public static final ReadingContext InterruptionEnd

Interruption end.

SampleClock

public static final ReadingContext SampleClock

Sample clock.

SamplePeriodic

public static final ReadingContext SamplePeriodic

Sample periodic.

TransactionBegin

public static final ReadingContext TransactionBegin

Transaction begin.

TransactionEnd

public static final ReadingContext TransactionEnd

Transaction end.

Other

public static final ReadingContext Other

Other.

Trigger

public static final ReadingContext Trigger

Trigger.

Method Details

values

public static ReadingContext[] 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 ReadingContext 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

getCode

public int getCode()

Get the code value.

Specified by:

getCode in interface net.solarnetwork.domain.CodedValue

Returns:

the code value

forCode

public static ReadingContext forCode(int code)

Get an enumeration value for a code value.

Parameters:

code - the code

Returns:

the status, never null and set to Unknown if not any other valid code