com.digi.android.gpio

Enum GPIOMode

java.lang.Object

java.lang.Enum<GPIOMode>

com.digi.android.gpio.GPIOMode

All Implemented Interfaces:

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

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

Enumerates the possible modes of a GPIO.

See Also:

GPIO

Enum Constant Summary

Enum Constants

Enum Constant and Description
INPUT Indicates that GPIO will be used as input.
INTERRUPT_EDGE_BOTH Indicates that GPIO will be used as an interrupt on both rising and falling edges.
INTERRUPT_EDGE_FALLING Indicates that GPIO will be used as an interrupt on falling edge.
INTERRUPT_EDGE_RISING Indicates that GPIO will be used as an interrupt on rising edge.
OUTPUT_HIGH Indicates that GPIO will be used as output and the output level will be set high.
OUTPUT_LOW Indicates that GPIO will be used as output and the output level will be set low.

Method Summary

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

INPUT

public static final GPIOMode INPUT

Indicates that GPIO will be used as input.

OUTPUT_HIGH

public static final GPIOMode OUTPUT_HIGH

Indicates that GPIO will be used as output and the output level will be set high.

OUTPUT_LOW

public static final GPIOMode OUTPUT_LOW

Indicates that GPIO will be used as output and the output level will be set low.

INTERRUPT_EDGE_RISING

public static final GPIOMode INTERRUPT_EDGE_RISING

Indicates that GPIO will be used as an interrupt on rising edge.

INTERRUPT_EDGE_FALLING

public static final GPIOMode INTERRUPT_EDGE_FALLING

Indicates that GPIO will be used as an interrupt on falling edge.

INTERRUPT_EDGE_BOTH

public static final GPIOMode INTERRUPT_EDGE_BOTH

Indicates that GPIO will be used as an interrupt on both rising and falling edges.

Method Detail

values

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

Returns:

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

valueOf

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

getId

public int getId()

Returns the GPIO mode ID.

Returns:

The GPIO mode ID.

getDescription

public java.lang.String getDescription()

Returns the GPIO mode description.

Returns:

The GPIO mode description.

getById

public static GPIOMode getById(int id)

Returns the GPIOMode associated to the provided mode ID.

Parameters:

id - The ID of the GPIOMode to retrieve.

Returns:

The GPIOMode associated to the provided mode ID.