Enum Class Status

java.lang.Object

java.lang.Enum<Status>

com.studica.frc.Status

All Implemented Interfaces:

Serializable, Comparable<Status>, Constable

public enum Status
extends Enum<Status>

Result of a StudicaLib command. Shared by every device.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEVICE_ERROR	The device answered but reported a failure.
IN_USE	Another object already uses this CAN ID or port.
INVALID_ARGUMENT	An argument was out of range.
INVALID_HANDLE	The device failed to open, or was closed.
OK	The command succeeded.
TIMEOUT	The device or service did not answer in time.
TRANSPORT_ERROR	The CAN bus or serial port could not be opened, written, or configured.
UNSUPPORTED	Not available over this connection (e.g.

Method Summary

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

OK

public static final Status OK

The command succeeded.

INVALID_HANDLE

public static final Status INVALID_HANDLE

The device failed to open, or was closed.

INVALID_ARGUMENT

public static final Status INVALID_ARGUMENT

An argument was out of range.

TIMEOUT

public static final Status TIMEOUT

The device or service did not answer in time.

UNSUPPORTED

public static final Status UNSUPPORTED

Not available over this connection (e.g. Colore USB_OVERRIDE over USB).

DEVICE_ERROR

public static final Status DEVICE_ERROR

The device answered but reported a failure.

IN_USE

public static final Status IN_USE

Another object already uses this CAN ID or port.

TRANSPORT_ERROR

public static final Status TRANSPORT_ERROR

The CAN bus or serial port could not be opened, written, or configured.

Method Details

values

public static Status[] 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 Status 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