Enum Class ExpendableSubsurfaceCategory

java.lang.Object

java.lang.Enum<ExpendableSubsurfaceCategory>

edu.nps.moves.dis7.enumerations.ExpendableSubsurfaceCategory

All Implemented Interfaces:

Category, Serializable, Comparable<ExpendableSubsurfaceCategory>, Constable

public enum ExpendableSubsurfaceCategory
extends Enum<ExpendableSubsurfaceCategory>
implements Category

This enum type is generated from XML, UID 27, marshal size 8; ExpendableSubsurfaceCategory has 7 enumerations total.

See Also:

• Java Tutorials: Enum Types
• Enum

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
ACTIVE_EMITTER	Active emitter
BUBBLE_MAKER_DECOY	Bubble-Maker Decoy
MULTI_MODE_DECOY	Multi-Mode Decoy
NOISE_MAKER_DECOY	Noise-Maker Decoy
OTHER	Other
PASSIVE_DECOY	Passive decoy
SIGNAL	Signal

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Provide enumeration description
static int	getEnumBitWidth()	bit width for this enumeration
static ExpendableSubsurfaceCategory	getEnumForValue(int value)	Provide enumeration for a given value
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
String	getName()	Provide name
boolean	getTRACE()	Whether tracing is on or off for this object
int	getValue()	Provide enumeration value
void	marshal(DataOutputStream dos)	Marshal value to DataOutputStream
void	marshal(ByteBuffer byteBuffer)	Marshal value to ByteBuffer
void	setTRACE(boolean value)	Set tracing on/off for this object
String	toString()	Provide simple identifier
static ExpendableSubsurfaceCategory	unmarshalEnum(DataInputStream dis)	Unmarshal value to DataInputStream
static ExpendableSubsurfaceCategory	unmarshalEnum(ByteBuffer byteBuffer)	Unmarshal enumeration value to ByteBuffer
static ExpendableSubsurfaceCategory	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ExpendableSubsurfaceCategory[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

OTHER

public static final ExpendableSubsurfaceCategory OTHER

Other

ACTIVE_EMITTER

public static final ExpendableSubsurfaceCategory ACTIVE_EMITTER

Active emitter

PASSIVE_DECOY

public static final ExpendableSubsurfaceCategory PASSIVE_DECOY

Passive decoy

SIGNAL

public static final ExpendableSubsurfaceCategory SIGNAL

Signal

NOISE_MAKER_DECOY

public static final ExpendableSubsurfaceCategory NOISE_MAKER_DECOY

Noise-Maker Decoy

BUBBLE_MAKER_DECOY

public static final ExpendableSubsurfaceCategory BUBBLE_MAKER_DECOY

Bubble-Maker Decoy

MULTI_MODE_DECOY

public static final ExpendableSubsurfaceCategory MULTI_MODE_DECOY

Multi-Mode Decoy

Method Details

values

public static ExpendableSubsurfaceCategory[] 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 ExpendableSubsurfaceCategory 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()

Provide enumeration value

Specified by:

getValue in interface Category

Returns:

integer value

getDescription

public String getDescription()

Provide enumeration description

Specified by:

getDescription in interface Category

Returns:

description

getEnumBitWidth

public static int getEnumBitWidth()

bit width for this enumeration

Returns:

number of bits wide

getEnumForValue

public static ExpendableSubsurfaceCategory getEnumForValue(int value)

Provide enumeration for a given value

Parameters:

value - integer value of interest

Returns:

enumeration corresponding to numeric value

setTRACE

public void setTRACE(boolean value)

Set tracing on/off for this object

Parameters:

value - whether tracing is on or off

getTRACE

public boolean getTRACE()

Whether tracing is on or off for this object

Returns:

whether tracing is on or off

marshal

public void marshal(DataOutputStream dos)
             throws IOException

Marshal value to DataOutputStream

Parameters:

dos - DataOutputStream for output

Throws:

IOException - input-output error

See Also:

• https://en.wikipedia.org/wiki/Marshalling_(computer_science)

marshal

public void marshal(ByteBuffer byteBuffer)
             throws Exception

Marshal value to ByteBuffer

Parameters:

byteBuffer - ByteBuffer for output

Throws:

IOException - input-output error

Exception

See Also:

• https://en.wikipedia.org/wiki/Marshalling_(computer_science)

unmarshalEnum

public static ExpendableSubsurfaceCategory unmarshalEnum(DataInputStream dis)
                                                  throws Exception

Unmarshal value to DataInputStream

Parameters:

dis - DataInputStream for input

Returns:

enumeration of interest

Throws:

Exception - unmarshalling input-output error

See Also:

• https://en.wikipedia.org/wiki/Marshalling_(computer_science)

unmarshalEnum

public static ExpendableSubsurfaceCategory unmarshalEnum(ByteBuffer byteBuffer)
                                                  throws Exception

Unmarshal enumeration value to ByteBuffer

Parameters:

byteBuffer - ByteBuffer for input

Returns:

enumeration of interest

Throws:

Exception - unmarshalling input-output error

See Also:

• https://en.wikipedia.org/wiki/Marshalling_(computer_science)

getMarshalledSize

public int getMarshalledSize()

Returns size of this serialized (marshalled) object in bytes

Returns:

serialized size in bytes

See Also:

• https://en.wikipedia.org/wiki/Marshalling_(computer_science)

getName

public String getName()

Provide name

Returns:

name

toString

public String toString()

Provide simple identifier

Overrides:

toString in class Enum<ExpendableSubsurfaceCategory>

Returns:

class name, value and name