Package uk.co.sculptor.kflibjava

Enum Class Field.FieldType

java.lang.Object

java.lang.Enum<Field.FieldType>

uk.co.sculptor.kflibjava.Field.FieldType

All Implemented Interfaces:

Serializable, Comparable<Field.FieldType>, Constable

Enclosing class:

Field

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

Field Sculptor field type (SCFT_*) 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
FLOAT	Floating point number
INTEGER	Signed integer
NULL	Null (no data)
NUMBER	Fixed point number
OBJNO	Object number (OLE object)
OLEOBJ	Object reference
TEXT	Text
UDEF	User defined
UNSIGNED	Unsigned integer

Method Summary

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

Null (no data)

UNSIGNED

public static final Field.FieldType UNSIGNED

Unsigned integer

INTEGER

public static final Field.FieldType INTEGER

Signed integer

NUMBER

public static final Field.FieldType NUMBER

Fixed point number

FLOAT

public static final Field.FieldType FLOAT

Floating point number

UDEF

public static final Field.FieldType UDEF

User defined

TEXT

public static final Field.FieldType TEXT

Text

BINARY

public static final Field.FieldType BINARY

Binary

OBJNO

public static final Field.FieldType OBJNO

Object number (OLE object)

OLEOBJ

public static final Field.FieldType OLEOBJ

Object reference

Method Details

values

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

Convert a received value to FieldType enumerator

Parameters:

scft - the Sculptor value to be translated to enumerator

Returns:

the enumerator value

Throws:

KfException - when the scft value is invalid

getFTFromDotdData

public static Field.FieldType getFTFromDotdData(int type,
 int size)

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

Parameters:

type - a dotd field type to generate the FieldType from

size - a dotd field size to generate the FieldType from

Returns:

The corresponding Field.FieldType value