Package com.digi.android.pwm

Enum PWMPolarity

java.lang.Object

java.lang.Enum<PWMPolarity>

com.digi.android.pwm.PWMPolarity

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

Enumerates the possible polarities of a PWM.

See Also:

PWM

Enum Constant Summary

Enum Constants

Enum Constant	Description
INVERSED	Indicates that the PWM polarity is inversed.
NORMAL	Indicates that the PWM polarity is normal.

Method Summary

Modifier and Type	Method	Description
static PWMPolarity	getByValue(java.lang.String value)	Returns the PWMPolarity associated to the provided polarity value.
java.lang.String	getValue()	Returns the PWM polarity value.
java.lang.String	toString()
static PWMPolarity	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static PWMPolarity[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NORMAL

public static final PWMPolarity NORMAL

Indicates that the PWM polarity is normal.

INVERSED

public static final PWMPolarity INVERSED

Indicates that the PWM polarity is inversed.

Method Detail

values

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

Returns:

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

valueOf

public static PWMPolarity 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 java.lang.String getValue()

Returns the PWM polarity value.

Returns:

The PWM polarity value.

getByValue

public static PWMPolarity getByValue(java.lang.String value)

Returns the PWMPolarity associated to the provided polarity value.

Parameters:

value - The value of the PWMPolarity to retrieve.

Returns:

The PWMPolarity associated to the provided polarity value, null if not found.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<PWMPolarity>