com.speedment.runtime.config

Interface Column

All Superinterfaces:

Document, HasAlias, HasColumnSize, HasDecimalDigits, HasDeepCopy, HasEnabled, HasEnumConstants, HasId, HasMainInterface, HasMutator<ColumnMutator<? extends Column>>, HasName, HasNullable, HasOrdinalPosition, HasParent<Table>, HasTypeMapper

public interface Column
extends Document, HasParent<Table>, HasEnabled, HasDeepCopy, HasId, HasName, HasAlias, HasNullable, HasOrdinalPosition, HasTypeMapper, HasDecimalDigits, HasColumnSize, HasMainInterface, HasEnumConstants, HasMutator<ColumnMutator<? extends Column>>

A typed Document that represents a column in the database. A Column is located inside a Table.

Since:

2.0.0

Author:

Emil Forslund

Nested Class Summary

Nested classes/interfaces inherited from interface com.speedment.runtime.config.trait.HasNullable

HasNullable.ImplementAs

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTO_INCREMENT

Fields inherited from interface com.speedment.runtime.config.trait.HasEnabled

ENABLED, ENABLED_DEFAULT

Fields inherited from interface com.speedment.runtime.config.trait.HasId

ID

Fields inherited from interface com.speedment.runtime.config.trait.HasAlias

ALIAS

Fields inherited from interface com.speedment.runtime.config.trait.HasNullable

NULLABLE, NULLABLE_IMPLEMENTATION

Fields inherited from interface com.speedment.runtime.config.trait.HasOrdinalPosition

COMPARATOR, ORDINAL_POSITION

Fields inherited from interface com.speedment.runtime.config.trait.HasTypeMapper

DATABASE_TYPE, TYPE_MAPPER

Fields inherited from interface com.speedment.runtime.config.trait.HasDecimalDigits

DECIMAL_DIGITS

Fields inherited from interface com.speedment.runtime.config.trait.HasColumnSize

COLUMN_SIZE

Fields inherited from interface com.speedment.runtime.config.trait.HasEnumConstants

ENUM_CONSTANTS

Method Summary

Modifier and Type	Method and Description
default Column	deepCopy() Returns a mutable copy of this document.
default boolean	isAutoIncrement() Returns whether or not this column will auto increment when new values are added to the table.
default Class<Column>	mainInterface() Returns the Class of the interface of this node.
default ColumnMutator<? extends Column>	mutator() Returns a DocumentMutator for this Document.

Methods inherited from interface com.speedment.runtime.config.trait.HasParent

getParent, getParentOrThrow

Methods inherited from interface com.speedment.runtime.config.trait.HasEnabled

isEnabled, of, test

Methods inherited from interface com.speedment.runtime.config.trait.HasId

getId, of

Methods inherited from interface com.speedment.runtime.config.trait.HasAlias

getAlias, getJavaName, of

Methods inherited from interface com.speedment.runtime.config.trait.HasNullable

getNullableImplementation, isNullable, of

Methods inherited from interface com.speedment.runtime.config.trait.HasOrdinalPosition

getOrdinalPosition, of

Methods inherited from interface com.speedment.runtime.config.trait.HasTypeMapper

findDatabaseType, getDatabaseType, getTypeMapper

Methods inherited from interface com.speedment.runtime.config.trait.HasDecimalDigits

getDecimalDigits

Methods inherited from interface com.speedment.runtime.config.trait.HasColumnSize

getColumnSize

Methods inherited from interface com.speedment.runtime.config.trait.HasEnumConstants

getEnumConstants

Field Detail

AUTO_INCREMENT

static final String AUTO_INCREMENT

See Also:

Constant Field Values

Method Detail

isAutoIncrement

default boolean isAutoIncrement()

Returns whether or not this column will auto increment when new values are added to the table.

Returns:

true if the column auto increments, else false

mainInterface

default Class<Column> mainInterface()

Description copied from interface: HasMainInterface

Returns the Class of the interface of this node.

This should not be overridden by implementing classes!

Specified by:

mainInterface in interface HasMainInterface

Returns:

the main interface class

mutator

default ColumnMutator<? extends Column> mutator()

Description copied from interface: HasMutator

Returns a DocumentMutator for this Document. A DocumentMutator allows a Document to be updated in a type safe way.

Specified by:

mutator in interface HasMutator<ColumnMutator<? extends Column>>

Returns:

a DocumentMutator for this Document

deepCopy

default Column deepCopy()

Description copied from interface: HasDeepCopy

Returns a mutable copy of this document. The deepCopy should be a deep copy, but does not need to use the same implementations as the original.

Specified by:

deepCopy in interface HasDeepCopy

Returns:

a mutable deep copy of the document