Module com.pi4j

Package com.pi4j.io.pwm

Enum Class PwmPolarity

java.lang.Object

java.lang.Enum<PwmPolarity>

com.pi4j.io.pwm.PwmPolarity

All Implemented Interfaces:

Serializable, Comparable<PwmPolarity>, Constable

public enum PwmPolarity
extends Enum<PwmPolarity>

PWM Polarity Enumerations

Version:

$Id: $Id

Author:

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

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INVERSED
NORMAL

Method Summary

Modifier and Type	Method	Description
static EnumSet<PwmPolarity>	all()	all.
String	getName()	Getter for the field name.
int	getValue()	Getter for the field value.
static PwmPolarity	parse(String polarity)	parse.
String	toString()
static PwmPolarity	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PwmPolarity[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NORMAL

public static final PwmPolarity NORMAL

INVERSED

public static final PwmPolarity INVERSED

Method Details

values

public static PwmPolarity[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static PwmPolarity valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class 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<PwmPolarity>

all

public static EnumSet<PwmPolarity> all()

all.

Returns:

a EnumSet object.

parse

public static PwmPolarity parse(String polarity)

parse.

Parameters:

polarity - a String object.

Returns:

a PwmPolarity object.