org.orekit.files.ccsds.section

Enum HeaderKey

java.lang.Object

java.lang.Enum<HeaderKey>

org.orekit.files.ccsds.section.HeaderKey

All Implemented Interfaces:

Serializable, Comparable<HeaderKey>

public enum HeaderKey
extends Enum<HeaderKey>

Keywords allowed in Header.

Since:

11.0

Author:

Luc Maisonobe

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMMENT Header comment.
CREATION_DATE Creation date.
MESSAGE_ID ID that uniquely identifies a message from a given originator.
ORIGINATOR Creating agency or operator.

Method Summary

Modifier and Type	Method and Description
boolean	process(ParseToken token, ContextBinding context, Header header) Process an token.
static HeaderKey	valueOf(String name) Returns the enum constant of this type with the specified name.
static HeaderKey[]	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

COMMENT

public static final HeaderKey COMMENT

Header comment.

CREATION_DATE

public static final HeaderKey CREATION_DATE

Creation date.

ORIGINATOR

public static final HeaderKey ORIGINATOR

Creating agency or operator.

MESSAGE_ID

public static final HeaderKey MESSAGE_ID

ID that uniquely identifies a message from a given originator.

Method Detail

values

public static HeaderKey[] 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 (HeaderKey c : HeaderKey.values())
    System.out.println(c);

Returns:

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

valueOf

public static HeaderKey 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

process

public boolean process(ParseToken token,
                       ContextBinding context,
                       Header header)

Process an token.

Parameters:

token - token to process

context - context binding

header - header to fill

Returns:

true of token was accepted