com.digi.android.gpio

Enum GPIOValue

java.lang.Object

java.lang.Enum<GPIOValue>

com.digi.android.gpio.GPIOValue

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<GPIOValue>

public enum GPIOValue
extends java.lang.Enum<GPIOValue>

Enumerates the possible values of a GPIO.

See Also:

GPIO

Enum Constant Summary

Enum Constants

Enum Constant and Description
HIGH Indicates that GPIO value is high.
LOW Indicates that GPIO value is low.

Method Summary

Modifier and Type	Method and Description
static GPIOValue	getById(int id) Returns the GPIOValue associated to the provided mode ID.
java.lang.String	getDescription() Returns the GPIO value description.
int	getValue() Returns the value of the GPIOValue.
static GPIOValue	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static GPIOValue[]	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, getSharedConstants, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LOW

public static final GPIOValue LOW

Indicates that GPIO value is low.

HIGH

public static final GPIOValue HIGH

Indicates that GPIO value is high.

Method Detail

values

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

Returns:

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

valueOf

public static GPIOValue valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getValue

public int getValue()

Returns the value of the GPIOValue.

Returns:

The value of the GPIOValue.

getDescription

public java.lang.String getDescription()

Returns the GPIO value description.

Returns:

The GPIO value description.

getById

public static GPIOValue getById(int id)

Returns the GPIOValue associated to the provided mode ID.

Parameters:

id - The ID of the GPIOValue to retrieve.

Returns:

The GPIOValue associated to the provided mode ID.