Module com.pi4j

Package com.pi4j.io.gpio.digital

Enum PullResistance

java.lang.Object

java.lang.Enum<PullResistance>

com.pi4j.io.gpio.digital.PullResistance

All Implemented Interfaces:

Serializable, Comparable<PullResistance>

public enum PullResistance
extends Enum<PullResistance>

Digital Pin Pull Resistance Enumerations

Version:

$Id: $Id

Author:

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

Enum Constant Summary

Enum Constants

Enum Constant	Description
OFF
PULL_DOWN
PULL_UP

Method Summary

Modifier and Type	Method	Description
static EnumSet<PullResistance>	all()	all.
String	getName()	Getter for the field name.
int	getValue()	Getter for the field value.
static PullResistance	parse(String pull)	parse.
String	toString()
static PullResistance	valueOf(String name)	Returns the enum constant of this type with the specified name.
static PullResistance[]	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

OFF

public static final PullResistance OFF

PULL_DOWN

public static final PullResistance PULL_DOWN

PULL_UP

public static final PullResistance PULL_UP

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public int getValue()

Getter for the field value.

Returns:

a int.

getName

public String getName()

Getter for the field name.

Returns:

a String object.

toString

public String toString()

Overrides:

toString in class Enum<PullResistance>

all

public static EnumSet<PullResistance> all()

all.

Returns:

a EnumSet object.

parse

public static PullResistance parse(String pull)

parse.

Parameters:

pull - a String object.

Returns:

a PullResistance object.