Module esa.opensf.osfi

Package esa.opensf.osfi

Enum Class Parameter.ParamType

java.lang.Object

java.lang.Enum<Parameter.ParamType>

esa.opensf.osfi.Parameter.ParamType

All Implemented Interfaces:

Serializable, Comparable<Parameter.ParamType>, Constable

Enclosing class:

Parameter

public static enum Parameter.ParamType
extends Enum<Parameter.ParamType>

Represents the element type of a Parameter object.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOOLEAN	Truth value.
FILE	Path to a file.
FLOAT	Floating point number, in decimal representation with the range of IEEE754 binary64.
FOLDER	Path to a folder, with the same rules as FILE.
INTEGER	Integral number, signed between Integer.MIN_VALUE and Integer.MAX_VALUE.
STRING	A string composed of alphanumeric, punctuation or whitespace characters (but excluding control characters e.g.
TIME	Timecode formatted as CCSDS ASCII time format with milli- or micro-second precision.

Method Summary

Modifier and Type	Method	Description
boolean	isStringBased()
static Parameter.ParamType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Parameter.ParamType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BOOLEAN

public static final Parameter.ParamType BOOLEAN

Truth value. Per the E2E-ICD, only TRUE or FALSE are accepted, capitalized.

FILE

public static final Parameter.ParamType FILE

Path to a file. If relative, it is resolved against the configured base directory.

FLOAT

public static final Parameter.ParamType FLOAT

Floating point number, in decimal representation with the range of IEEE754 binary64. The E2E-ICD defines the limits using the Java type double.

FOLDER

public static final Parameter.ParamType FOLDER

Path to a folder, with the same rules as FILE.

INTEGER

public static final Parameter.ParamType INTEGER

Integral number, signed between Integer.MIN_VALUE and Integer.MAX_VALUE. The E2E-ICD defines the limits using the Java type int.

STRING

public static final Parameter.ParamType STRING

A string composed of alphanumeric, punctuation or whitespace characters (but excluding control characters e.g. "\n") with length ranging from 0 to 255.

Note that OSFI does not place a limit on string length or contents.

TIME

public static final Parameter.ParamType TIME

Timecode formatted as CCSDS ASCII time format with milli- or micro-second precision.

Note that, notwithstanding the E2E-ICD, OSFI allows up to nanosecond precision.

See Also:

• TimeValue

Method Details

values

public static Parameter.ParamType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Parameter.ParamType valueOf(String name)

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

NullPointerException - if the argument is null

isStringBased

public boolean isStringBased()

Returns:

true if this type follows "string" rules, that is, it may have blanks embedded and thus any non-scalars must be quoted.