Package edu.wpi.first.wpilibj

Enum XboxController.Button

java.lang.Object

java.lang.Enum<XboxController.Button>

edu.wpi.first.wpilibj.XboxController.Button

All Implemented Interfaces:

Serializable, Comparable<XboxController.Button>, Constable

Enclosing class:

XboxController

public static enum XboxController.Button
extends Enum<XboxController.Button>

Represents a digital button on an XboxController.

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
kA	A.
kB	B.
kBack	Back.
kLeftBumper	Left bumper.
kLeftStick	Left stick.
kRightBumper	Right bumper.
kRightStick	Right stick.
kStart	Start.
kX	X.
kY	Y.

Field Summary

Fields

Modifier and Type	Field	Description
int	value	Button value.

Method Summary

Modifier and Type	Method	Description
String	toString()	Get the human-friendly name of the button, matching the relevant methods.
static XboxController.Button	valueOf(String name)	Returns the enum constant of this type with the specified name.
static XboxController.Button[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

kLeftBumper

public static final XboxController.Button kLeftBumper

Left bumper.

kRightBumper

public static final XboxController.Button kRightBumper

Right bumper.

kLeftStick

public static final XboxController.Button kLeftStick

Left stick.

kRightStick

public static final XboxController.Button kRightStick

Right stick.

kA

public static final XboxController.Button kA

A.

kB

public static final XboxController.Button kB

B.

kX

public static final XboxController.Button kX

X.

kY

public static final XboxController.Button kY

Y.

kBack

public static final XboxController.Button kBack

Back.

kStart

public static final XboxController.Button kStart

Start.

Field Details

value

public final int value

Button value.

Method Details

values

public static XboxController.Button[] 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 XboxController.Button 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

toString

public String toString()

Get the human-friendly name of the button, matching the relevant methods. This is done by stripping the leading `k`, and if not a Bumper button append `Button`.

Primarily used for automated unit tests.

Overrides:

toString in class Enum<XboxController.Button>

Returns:

the human-friendly name of the button.