edu.nps.moves.disenum
Enum ProtocolFamily

java.lang.Object
  java.lang.Enum<ProtocolFamily>
      edu.nps.moves.disenum.ProtocolFamily

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ProtocolFamily>

public enum ProtocolFamily
extends java.lang.Enum<ProtocolFamily>

Enumeration values for ProtocolFamily The enumeration values are generated from the SISO DIS XML EBV document (R35), which was obtained from http://discussions.sisostds.org/default.asp?action=10&fd=31

Note that this has two ways to look up an enumerated instance from a value: a fast but brittle array lookup, and a slower and more garbage-intensive, but safer, method. if you want to minimize memory use, get rid of one or the other.

Copyright 2008-2009. This work is licensed under the BSD license, available at http://www.movesinstitute.org/licenses

Author:

DMcG, Jason Nelson

Enum Constant Summary

DISTRIBUTED_EMISSION_REGENERATION

ENTITY_INFORMATION_INTERACTION

ENTITY_MANAGEMENT

EXPERIMENTAL_COMPUTER_GENERATED_FORCES

LIVE_ENTITY

LOGISTICS

MINEFIELD

NON_REAL_TIME

OTHER

RADIO_COMMUNICATION

SIMULATION_MANAGEMENT

SIMULATION_MANAGEMENT_WITH_RELIABILITY

SYNTHETIC_ENVIRONMENT

WARFARE

Field Summary

java.lang.String	description Text/english description of the enumerated value
static ProtocolFamily[]	lookup This is an array, with each slot corresponding to an enumerated value.
int	value The enumerated value

Method Summary

static boolean	enumerationForValueExists(int aVal) Returns true if there is an enumerated instance for this value, false otherwise.
java.lang.String	getDescription() Returns a text descriptioni for this enumerated value.
static java.lang.String	getDescriptionForValue(int aVal) Returns the string description associated with the enumerated instance with this value.
static ProtocolFamily	getEnumerationForValue(int aVal) Returns the enumerated instance with this value.
int	getValue() Returns the enumerated value for this enumeration
static ProtocolFamily	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ProtocolFamily[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OTHER

public static final ProtocolFamily OTHER

ENTITY_INFORMATION_INTERACTION

public static final ProtocolFamily ENTITY_INFORMATION_INTERACTION

WARFARE

public static final ProtocolFamily WARFARE

LOGISTICS

public static final ProtocolFamily LOGISTICS

RADIO_COMMUNICATION

public static final ProtocolFamily RADIO_COMMUNICATION

SIMULATION_MANAGEMENT

public static final ProtocolFamily SIMULATION_MANAGEMENT

DISTRIBUTED_EMISSION_REGENERATION

public static final ProtocolFamily DISTRIBUTED_EMISSION_REGENERATION

ENTITY_MANAGEMENT

public static final ProtocolFamily ENTITY_MANAGEMENT

MINEFIELD

public static final ProtocolFamily MINEFIELD

SYNTHETIC_ENVIRONMENT

public static final ProtocolFamily SYNTHETIC_ENVIRONMENT

SIMULATION_MANAGEMENT_WITH_RELIABILITY

public static final ProtocolFamily SIMULATION_MANAGEMENT_WITH_RELIABILITY

LIVE_ENTITY

public static final ProtocolFamily LIVE_ENTITY

NON_REAL_TIME

public static final ProtocolFamily NON_REAL_TIME

EXPERIMENTAL_COMPUTER_GENERATED_FORCES

public static final ProtocolFamily EXPERIMENTAL_COMPUTER_GENERATED_FORCES

Field Detail

value

public final int value

The enumerated value

description

public final java.lang.String description

Text/english description of the enumerated value

lookup

public static ProtocolFamily[] lookup

This is an array, with each slot corresponding to an enumerated value. This is a fast but brittle way to look up enumerated values. If there is no enumeration corresponding to the value it will fail, and it will also fail if the index it out of range of the array. But it is fast, and generates less garbage than the alternative of using getEnumerationForValue(). It should be used only in real-time environments, and be careful even then.

Use as ProtocolFamily.lookup[aVal] to get the enumeration that corresponds to a value.

In non-realtime environments, the prefered method is getEnumerationForValue().

Method Detail

values

public static final ProtocolFamily[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(ProtocolFamily c : ProtocolFamily.values())
        System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they're declared

valueOf

public static ProtocolFamily valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

getDescriptionForValue

public static java.lang.String getDescriptionForValue(int aVal)

Returns the string description associated with the enumerated instance with this value. If there is no enumerated instance for this value, the string Invalid enumeration: is returned.

getEnumerationForValue

public static ProtocolFamily getEnumerationForValue(int aVal)
                                             throws edu.nps.moves.siso.EnumNotFoundException

Returns the enumerated instance with this value. If there is no enumerated instance for this value, the exception is thrown.

Throws:

edu.nps.moves.siso.EnumNotFoundException

enumerationForValueExists

public static boolean enumerationForValueExists(int aVal)

Returns true if there is an enumerated instance for this value, false otherwise.

getValue

public int getValue()

Returns the enumerated value for this enumeration

getDescription

public java.lang.String getDescription()

Returns a text descriptioni for this enumerated value. This is usually used as the basis for the enumeration name.