org.datanucleus.store.schema.naming

Enum ColumnType

java.lang.Object

java.lang.Enum<ColumnType>

org.datanucleus.store.schema.naming.ColumnType

All Implemented Interfaces:

Serializable, Comparable<ColumnType>

public enum ColumnType
extends Enum<ColumnType>

Enum defining the types of columns.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADAPTER_COLUMN Adapter column (for join table primary-key).
COLUMN Normal column.
DATASTOREID_COLUMN Column for (surrogate) datastore id.
DISCRIMINATOR_COLUMN Column for discriminator.
FK_COLUMN FK column (either 1-1, or 1-N in element, or 1-N join table to element.
INDEX_COLUMN Column for index position of a list/array.
JOIN_OWNER_COLUMN 1-N join table column back to owner.
MULTITENANCY_COLUMN Column for multitenancy.
VERSION_COLUMN Column for version.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

COLUMN

public static final ColumnType COLUMN

Normal column.

DATASTOREID_COLUMN

public static final ColumnType DATASTOREID_COLUMN

Column for (surrogate) datastore id.

VERSION_COLUMN

public static final ColumnType VERSION_COLUMN

Column for version.

DISCRIMINATOR_COLUMN

public static final ColumnType DISCRIMINATOR_COLUMN

Column for discriminator.

MULTITENANCY_COLUMN

public static final ColumnType MULTITENANCY_COLUMN

Column for multitenancy.

INDEX_COLUMN

public static final ColumnType INDEX_COLUMN

Column for index position of a list/array.

FK_COLUMN

public static final ColumnType FK_COLUMN

FK column (either 1-1, or 1-N in element, or 1-N join table to element.

JOIN_OWNER_COLUMN

public static final ColumnType JOIN_OWNER_COLUMN

1-N join table column back to owner.

ADAPTER_COLUMN

public static final ColumnType ADAPTER_COLUMN

Adapter column (for join table primary-key).

Method Detail

values

public static ColumnType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ColumnType c : ColumnType.values())
    System.out.println(c);

Returns:

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

valueOf

public static ColumnType valueOf(String name)

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

NullPointerException - if the argument is null