com.pi4j.component.relay

Enum RelayState

java.lang.Object

java.lang.Enum<RelayState>

com.pi4j.component.relay.RelayState

All Implemented Interfaces:

Serializable, Comparable<RelayState>

public enum RelayState
extends Enum<RelayState>

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLOSED
OPEN

Method Summary

Methods

Modifier and Type	Method and Description
static RelayState	getInverseState(RelayState state)
static RelayState	valueOf(String name) Returns the enum constant of this type with the specified name.
static RelayState[]	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

OPEN

public static final RelayState OPEN

CLOSED

public static final RelayState CLOSED

Method Detail

values

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

Returns:

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

valueOf

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

getInverseState

public static RelayState getInverseState(RelayState state)