Package edu.wpi.first.wpilibj2.command

Enum Class Command.InterruptionBehavior

java.lang.Object

java.lang.Enum<Command.InterruptionBehavior>

edu.wpi.first.wpilibj2.command.Command.InterruptionBehavior

All Implemented Interfaces:

Serializable, Comparable<Command.InterruptionBehavior>, Constable

Enclosing class:

Command

public static enum Command.InterruptionBehavior
extends Enum<Command.InterruptionBehavior>

An enum describing the command's behavior when another command with a shared requirement is scheduled.

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
kCancelIncoming	This command continues, and the incoming command is not scheduled.
kCancelSelf	This command ends, end(true) is called, and the incoming command is scheduled normally.

Method Summary

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

kCancelSelf

public static final Command.InterruptionBehavior kCancelSelf

This command ends, end(true) is called, and the incoming command is scheduled normally.

This is the default behavior.

kCancelIncoming

public static final Command.InterruptionBehavior kCancelIncoming

This command continues, and the incoming command is not scheduled.

Method Details

values

public static Command.InterruptionBehavior[] 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 Command.InterruptionBehavior 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