Package org.orekit.files.ccsds.section

Enum XmlStructureKey

java.lang.Object

java.lang.Enum<XmlStructureKey>

org.orekit.files.ccsds.section.XmlStructureKey

All Implemented Interfaces:

Serializable, Comparable<XmlStructureKey>

public enum XmlStructureKey
extends Enum<XmlStructureKey>

Keys for FileFormat.XML format structure.

Since:

11.0

Author:

Luc Maisonobe

Enum Constant Summary

Enum Constants

Enum Constant	Description
body	Body structure.
data	XML data structure.
header	Header structure.
metadata	XML metadata structure.
segment	Segment structure.

Method Summary

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

body

public static final XmlStructureKey body

Body structure.

segment

public static final XmlStructureKey segment

Segment structure.

header

public static final XmlStructureKey header

Header structure.

metadata

public static final XmlStructureKey metadata

XML metadata structure.

data

public static final XmlStructureKey data

XML data structure.

Method Detail

values

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

Returns:

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

valueOf

public static XmlStructureKey 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,
                       AbstractConstituentParser<?,?,?> parser)

Process an token.

Parameters:

token - token to process

parser - file parser

Returns:

true of token was accepted