org.orekit.files.ilrs

Enum StreamingCpfWriter.HeaderLineWriter

java.lang.Object

java.lang.Enum<StreamingCpfWriter.HeaderLineWriter>

org.orekit.files.ilrs.StreamingCpfWriter.HeaderLineWriter

All Implemented Interfaces:

Serializable, Comparable<StreamingCpfWriter.HeaderLineWriter>

Enclosing class:

StreamingCpfWriter

public static enum StreamingCpfWriter.HeaderLineWriter
extends Enum<StreamingCpfWriter.HeaderLineWriter>

Writer for specific header lines.

Enum Constant Summary

Enum Constants

Enum Constant and Description
H1 Header first line.
H2 Header second line.

Method Summary

Modifier and Type	Method and Description
String	getIdentifier() Get the regular expression for identifying line.
static StreamingCpfWriter.HeaderLineWriter	valueOf(String name) Returns the enum constant of this type with the specified name.
static StreamingCpfWriter.HeaderLineWriter[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
abstract void	write(CPFHeader cpfHeader, Appendable cpfWriter, TimeScale timescale) Write a line.

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

H1

public static final StreamingCpfWriter.HeaderLineWriter H1

Header first line.

H2

public static final StreamingCpfWriter.HeaderLineWriter H2

Header second line.

Method Detail

values

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

Returns:

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

valueOf

public static StreamingCpfWriter.HeaderLineWriter 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

write

public abstract void write(CPFHeader cpfHeader,
                           Appendable cpfWriter,
                           TimeScale timescale)
                    throws IOException

Write a line.

Parameters:

cpfHeader - container for header data

cpfWriter - writer

timescale - time scale for dates

Throws:

IOException - if any buffer writing operations fail or if the underlying format doesn't support a configuration in the file

getIdentifier

public String getIdentifier()

Get the regular expression for identifying line.

Returns:

the regular expression for identifying line