Enum Class Coroutine.WaitResult

java.lang.Object

java.lang.Enum<Coroutine.WaitResult>

org.wpilib.command3.Coroutine.WaitResult

All Implemented Interfaces:

Serializable, Comparable<Coroutine.WaitResult>, Constable

Enclosing class:

Coroutine

public static enum Coroutine.WaitResult
extends Enum<Coroutine.WaitResult>

Represents the result of a call to Coroutine.waitUntil(BooleanSupplier) or Coroutine.waitUntil(BooleanSupplier, Time).

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONDITION_MET	A call to waitUntil has met its condition.
TIMED_OUT	A call to Coroutine.waitUntil(BooleanSupplier, Time) has timed out.

Method Summary

Modifier and Type	Method	Description
abstract boolean	timedOut()	Checks if the wait has timed out.
static Coroutine.WaitResult	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Coroutine.WaitResult[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CONDITION_MET

public static final Coroutine.WaitResult CONDITION_MET

A call to waitUntil has met its condition.

TIMED_OUT

public static final Coroutine.WaitResult TIMED_OUT

A call to Coroutine.waitUntil(BooleanSupplier, Time) has timed out.

Method Details

values

public static Coroutine.WaitResult[] 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 Coroutine.WaitResult 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

timedOut

public abstract boolean timedOut()

Checks if the wait has timed out.

Returns:

true if this result was a timeout, false if the condition was met without timing out.