org.jmisb.api.klv.st0808

Enum AncillaryTextMetadataKey

java.lang.Object

java.lang.Enum<AncillaryTextMetadataKey>

org.jmisb.api.klv.st0808.AncillaryTextMetadataKey

All Implemented Interfaces:

Serializable, Comparable<AncillaryTextMetadataKey>, IKlvKey

public enum AncillaryTextMetadataKey
extends Enum<AncillaryTextMetadataKey>
implements IKlvKey

ST 0808 tags - description and numbers.

Enum Constant Summary

Enum Constants

Enum Constant and Description
MessageBody
MessageCreationTime
Originator
PrecisionTimeStamp
Source
Undefined Unknown key.

Method Summary

Modifier and Type	Method and Description
int	getIdentifier() Get the tag value associated with this enumeration value.
static AncillaryTextMetadataKey	getKey(int tag) Look up the metadata key by tag identifier.
static AncillaryTextMetadataKey	valueOf(String name) Returns the enum constant of this type with the specified name.
static AncillaryTextMetadataKey[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Undefined

public static final AncillaryTextMetadataKey Undefined

Unknown key. This should not be created.

Originator

public static final AncillaryTextMetadataKey Originator

PrecisionTimeStamp

public static final AncillaryTextMetadataKey PrecisionTimeStamp

MessageBody

public static final AncillaryTextMetadataKey MessageBody

Source

public static final AncillaryTextMetadataKey Source

MessageCreationTime

public static final AncillaryTextMetadataKey MessageCreationTime

Method Detail

values

public static AncillaryTextMetadataKey[] values()

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

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

Returns:

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

valueOf

public static AncillaryTextMetadataKey valueOf(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:

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

NullPointerException - if the argument is null

getIdentifier

public int getIdentifier()

Get the tag value associated with this enumeration value.

Specified by:

getIdentifier in interface IKlvKey

Returns:

integer tag value for the metadata key

getKey

public static AncillaryTextMetadataKey getKey(int tag)

Look up the metadata key by tag identifier.

Parameters:

tag - the integer tag value to look up

Returns:

corresponding metadata key