Package edu.wpi.first.wpilibj

Enum Relay.Direction

java.lang.Object

java.lang.Enum<Relay.Direction>

edu.wpi.first.wpilibj.Relay.Direction

All Implemented Interfaces:

Serializable, Comparable<Relay.Direction>, java.lang.constant.Constable

Enclosing class:

Relay

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

The Direction(s) that a relay is configured to operate in.

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
kBoth	direction: both directions are valid.
kForward	direction: Only forward is valid.
kReverse	direction: only reverse is valid.

Method Summary

Modifier and Type	Method	Description
static Relay.Direction	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Relay.Direction[]	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, 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

kBoth

public static final Relay.Direction kBoth

direction: both directions are valid.

kForward

public static final Relay.Direction kForward

direction: Only forward is valid.

kReverse

public static final Relay.Direction kReverse

direction: only reverse is valid.

Method Details

values

public static Relay.Direction[] values()

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

Returns:

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

valueOf

public static Relay.Direction 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