Package edu.wpi.first.wpilibj

Enum Class Relay.Value

java.lang.Object

java.lang.Enum<Relay.Value>

edu.wpi.first.wpilibj.Relay.Value

All Implemented Interfaces:

Serializable, Comparable<Relay.Value>, Constable

Enclosing class:

Relay

public static enum Relay.Value
extends Enum<Relay.Value>

The state to drive a Relay to.

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
kForward	Forward.
kOff	Off.
kOn	On.
kReverse	Reverse.

Method Summary

Modifier and Type	Method	Description
String	getPrettyValue()	Returns the pretty string representation of the value.
static Optional<Relay.Value>	getValueOf(String value)	Returns the value for a given pretty string.
static Relay.Value	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Relay.Value[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

kOff

public static final Relay.Value kOff

Off.

kOn

public static final Relay.Value kOn

On.

kForward

public static final Relay.Value kForward

Forward.

kReverse

public static final Relay.Value kReverse

Reverse.

Method Details

values

public static Relay.Value[] 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 Relay.Value 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

getPrettyValue

public String getPrettyValue()

Returns the pretty string representation of the value.

Returns:

The pretty string representation of the value.

getValueOf

public static Optional<Relay.Value> getValueOf(String value)

Returns the value for a given pretty string.

Parameters:

value - The pretty string.

Returns:

The value or an empty optional if there is no corresponding value.