Package net.solarnetwork.ocpp.domain

Enum Class Phase

java.lang.Object

java.lang.Enum<Phase>

net.solarnetwork.ocpp.domain.Phase

All Implemented Interfaces:

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

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

An AC phase.

Version:

1.1

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
L1	Measured on L1.
L1L2	Measured between L1 and L2.
L1N	Measured on L1 with respect to Neutral conductor.
L2	Measured on L2.
L2L3	Measured between L2 and L3.
L2N	Measured on L2 with respect to Neutral conductor.
L3	Measured on L3.
L3L1	Measured between L3 and L1.
L3N	Measured on L3 with respect to Neutral conductor.
N	Measured on Neutral.
Unknown	Unknown.

Method Summary

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

Unknown.

L1

public static final Phase L1

Measured on L1.

L2

public static final Phase L2

Measured on L2.

L3

public static final Phase L3

Measured on L3.

N

public static final Phase N

Measured on Neutral.

L1N

public static final Phase L1N

Measured on L1 with respect to Neutral conductor.

L2N

public static final Phase L2N

Measured on L2 with respect to Neutral conductor.

L3N

public static final Phase L3N

Measured on L3 with respect to Neutral conductor.

L1L2

public static final Phase L1L2

Measured between L1 and L2.

L2L3

public static final Phase L2L3

Measured between L2 and L3.

L3L1

public static final Phase L3L1

Measured between L3 and L1.

Method Details

values

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