Package uk.co.sculptor.kflibjava

Enum Class Field.ArithmeticDataType

java.lang.Object

java.lang.Enum<Field.ArithmeticDataType>

uk.co.sculptor.kflibjava.Field.ArithmeticDataType

All Implemented Interfaces:

Serializable, Comparable<Field.ArithmeticDataType>, Constable

Enclosing class:

Field

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

Field Arithmetic data type (KF_TEXT, KF_LONG, KF_DOUBLE, KF_BINARY) 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
BINARY	Binary field
DOUBLE	Float field
LONG	Integer field
TEXT	Alpha field

Method Summary

Modifier and Type	Method	Description
static Field.ArithmeticDataType	getAdtFromDotdData(int type, int size)	This function is used to return the Field.ArithmeticDataType value extracted from the dotd file field information
byte	getByte()	Returns the Field Arithmetic data type as the byte value used on KfServer
static Field.ArithmeticDataType	getFromByte(byte adt)	Convert a received value to ArithmeticDataType enumerator
static Field.ArithmeticDataType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Field.ArithmeticDataType[]	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

TEXT

public static final Field.ArithmeticDataType TEXT

Alpha field

LONG

public static final Field.ArithmeticDataType LONG

Integer field

DOUBLE

public static final Field.ArithmeticDataType DOUBLE

Float field

BINARY

public static final Field.ArithmeticDataType BINARY

Binary field

Method Details

values

public static Field.ArithmeticDataType[] 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.ArithmeticDataType 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.ArithmeticDataType getFromByte(byte adt)
                                            throws KfException

Convert a received value to ArithmeticDataType enumerator

Parameters:

adt - the Sculptor value to be translated to enumerator

Returns:

the enumerator value

Throws:

KfException - when the adt value is invalid

getAdtFromDotdData

public static Field.ArithmeticDataType getAdtFromDotdData(int type,
 int size)

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

Parameters:

type - a dotd field type to generate the ArithmeticDataType from

size - a dotd field size to generate the ArithmeticDataType from

Returns:

The corresponding Field.ArithmeticDataType value

getByte

public byte getByte()

Returns the Field Arithmetic data type as the byte value used on KfServer

Returns:

Field Arithmetic data type as the byte value used on KfServer