Enum Class SharedMapState

java.lang.Object

java.lang.Enum<SharedMapState>

com.limelightvision.SharedMapState

All Implemented Interfaces:

Serializable, Comparable<SharedMapState>, Constable

public enum SharedMapState
extends Enum<SharedMapState>

Shared field map state reported by the camera.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACTIVE	The shared map is in use.
OFF	No shared map published.
PARSE_ERROR	The published map failed to parse or was too large.
UNKNOWN	The camera reported a state this library does not know.

Method Summary

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

OFF

public static final SharedMapState OFF

No shared map published.

ACTIVE

public static final SharedMapState ACTIVE

The shared map is in use.

PARSE_ERROR

public static final SharedMapState PARSE_ERROR

The published map failed to parse or was too large.

UNKNOWN

public static final SharedMapState UNKNOWN

The camera reported a state this library does not know.

Method Details

values

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