Package uk.co.sculptor.kflibjava

Enum Class Field.LogicalDataType

java.lang.Object

java.lang.Enum<Field.LogicalDataType>

uk.co.sculptor.kflibjava.Field.LogicalDataType

All Implemented Interfaces:

Serializable, Comparable<Field.LogicalDataType>, Constable

Enclosing class:

Field

public static enum Field.LogicalDataType
extends Enum<Field.LogicalDataType>

Field Sculptor Logical Data type (SCLT_*) enumerator.

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
CURRENCY	Currency
DAYNO	Date (day number)
DTIME	Date and time (seconds)
EDAYS	Elapsed days
EHOURS	Elapsed hours
EMICS	Elapsed milliseconds
EMILS	Elapsed milliseconds
EMINS	Elapsed minutes
ESECS	Elapsed seconds
MONEY	Sculptor 2 money
NULL	No interpretation
TMILS	Clock time (milliseconds)
TSECS	Clock time (seconds)

Method Summary

Modifier and Type	Method	Description
static Field.LogicalDataType	getFromByte(byte sclt)	Convert a received value to LogicalDataType enumerator
static Field.LogicalDataType	getLDTFromDotdData(int type)	This function is used to return the Field.LogicalDataType value extracted from the dotd file field information
static Field.LogicalDataType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Field.LogicalDataType[]	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

NULL

public static final Field.LogicalDataType NULL

No interpretation

DAYNO

public static final Field.LogicalDataType DAYNO

Date (day number)

TSECS

public static final Field.LogicalDataType TSECS

Clock time (seconds)

DTIME

public static final Field.LogicalDataType DTIME

Date and time (seconds)

EDAYS

public static final Field.LogicalDataType EDAYS

Elapsed days

EHOURS

public static final Field.LogicalDataType EHOURS

Elapsed hours

EMINS

public static final Field.LogicalDataType EMINS

Elapsed minutes

ESECS

public static final Field.LogicalDataType ESECS

Elapsed seconds

EMILS

public static final Field.LogicalDataType EMILS

Elapsed milliseconds

EMICS

public static final Field.LogicalDataType EMICS

Elapsed milliseconds

TMILS

public static final Field.LogicalDataType TMILS

Clock time (milliseconds)

CURRENCY

public static final Field.LogicalDataType CURRENCY

Currency

MONEY

public static final Field.LogicalDataType MONEY

Sculptor 2 money

Method Details

values

public static Field.LogicalDataType[] 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 Field.LogicalDataType 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

getFromByte

public static Field.LogicalDataType getFromByte(byte sclt)
                                         throws KfException

Convert a received value to LogicalDataType enumerator

Parameters:

sclt - the Sculptor value to be translated to enumerator

Returns:

the enumerator value

Throws:

KfException - when the sclt value is invalid

getLDTFromDotdData

public static Field.LogicalDataType getLDTFromDotdData(int type)

This function is used to return the Field.LogicalDataType value extracted from the dotd file field information

Parameters:

type - a dotd field type to generate the LogicalDataType from

Returns:

The corresponding Field.LogicalDataType value