Package uk.ac.manchester.spinnaker.messages.eieio

Enum Class EIEIOPrefix

java.lang.Object

java.lang.Enum<EIEIOPrefix>

uk.ac.manchester.spinnaker.messages.eieio.EIEIOPrefix

All Implemented Interfaces:

Serializable, Comparable<EIEIOPrefix>, Constable

public enum EIEIOPrefix
extends Enum<EIEIOPrefix>

Possible prefixing of keys in EIEIO packets.

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
LOWER_HALF_WORD	Apply prefix on lower half of the word.
UPPER_HALF_WORD	Apply prefix on top half of the word.

Method Summary

Modifier and Type	Method	Description
static EIEIOPrefix	getByValue(int value)	Get the prefix encoding given its encoded form.
int	getValue()
static EIEIOPrefix	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EIEIOPrefix[]	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

LOWER_HALF_WORD

public static final EIEIOPrefix LOWER_HALF_WORD

Apply prefix on lower half of the word.

UPPER_HALF_WORD

public static final EIEIOPrefix UPPER_HALF_WORD

Apply prefix on top half of the word.

Method Details

values

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

getValue

public int getValue()

Returns:

the encoded form.

getByValue

public static EIEIOPrefix getByValue(int value)

Get the prefix encoding given its encoded form.

Parameters:

value - The encoded prefix encoding.

Returns:

The prefix encoding object

Throws:

IllegalArgumentException - if the encoded prefix encoding is unrecognised.