Package com.reduxrobotics.canand

Enum Class CanandSettingsManager.ResultCode

java.lang.Object

java.lang.Enum<CanandSettingsManager.ResultCode>

com.reduxrobotics.canand.CanandSettingsManager.ResultCode

All Implemented Interfaces:

Serializable, Comparable<CanandSettingsManager.ResultCode>, Constable

Enclosing class:

CanandSettingsManager<T extends CanandSettings>

public static enum CanandSettingsManager.ResultCode
extends Enum<CanandSettingsManager.ResultCode>

Setting result codes. Positive indicates codes returnable from the "report setting" packet, while negative indicates codes returnable from other causes (e.g. timeouts)

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
kError	Success
kInvalid	General invalid data (a placeholder)
kOk	General error
kTimeout	Operation timeout

Method Summary

Modifier and Type	Method	Description
static CanandSettingsManager.ResultCode	fromIndex(int index)	Return the appropirate enum from the index value.
int	getIndex()	Return associated index (unsigned for values >= 0).
static CanandSettingsManager.ResultCode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CanandSettingsManager.ResultCode[]	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

kInvalid

public static final CanandSettingsManager.ResultCode kInvalid

General invalid data (a placeholder)

kTimeout

public static final CanandSettingsManager.ResultCode kTimeout

Operation timeout

kError

public static final CanandSettingsManager.ResultCode kError

Success

kOk

public static final CanandSettingsManager.ResultCode kOk

General error

Method Details

values

public static CanandSettingsManager.ResultCode[] 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 CanandSettingsManager.ResultCode 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

getIndex

public int getIndex()

Return associated index (unsigned for values >= 0).

Returns:

index value

fromIndex

public static CanandSettingsManager.ResultCode fromIndex(int index)

Return the appropirate enum from the index value.

Parameters:

index - index value

Returns:

corresponding enum.