Package com.pi4j.io.gpio

Enum PinState

java.lang.Object

java.lang.Enum<PinState>

com.pi4j.io.gpio.PinState

All Implemented Interfaces:

Serializable, Comparable<PinState>

public enum PinState
extends Enum<PinState>

Pin edge definition.

Author:

Robert Savage (http://www.savagehomeautomation.com)

Enum Constant Summary

Enum Constants

Enum Constant	Description
HIGH
LOW

Method Summary

Modifier and Type	Method	Description
static EnumSet<PinState>	all()
static PinState[]	allStates()
static PinState	getInverseState(PinState state)
String	getName()
static PinState	getState(boolean state)
static PinState	getState(int state)
int	getValue()
boolean	isHigh()
boolean	isLow()
String	toString()
static PinState	valueOf(String name)	Returns the enum constant of this type with the specified name.
static PinState[]	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

Enum Constant Detail

LOW

public static final PinState LOW

HIGH

public static final PinState HIGH

Method Detail

values

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

Returns:

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

valueOf

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

isHigh

public boolean isHigh()

isLow

public boolean isLow()

getValue

public int getValue()

getName

public String getName()

toString

public String toString()

Overrides:

toString in class Enum<PinState>

getState

public static PinState getState(int state)

getInverseState

public static PinState getInverseState(PinState state)

getState

public static PinState getState(boolean state)

allStates

public static PinState[] allStates()

all

public static EnumSet<PinState> all()