Package io.vertigo.datamodel.data.definitions

Enum Class DataField.FieldType

java.lang.Object

java.lang.Enum<DataField.FieldType>

io.vertigo.datamodel.data.definitions.DataField.FieldType

All Implemented Interfaces:

Serializable, Comparable<DataField.FieldType>, Constable

Enclosing class:

DataField

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

This enum lists all types that can be used by a field. The most common types are ID and DATA

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
COMPUTED	a computed field
DATA	a simple data field
FOREIGN_KEY	a link towards an other entity
ID	identity

Method Summary

Modifier and Type	Method	Description
boolean	isId()
static DataField.FieldType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DataField.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

ID

public static final DataField.FieldType ID

identity

DATA

public static final DataField.FieldType DATA

a simple data field

FOREIGN_KEY

public static final DataField.FieldType FOREIGN_KEY

a link towards an other entity

COMPUTED

public static final DataField.FieldType COMPUTED

a computed field

Method Details

values

public static DataField.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 DataField.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

isId

public boolean isId()

Returns:

if the field is the 'id'