Module org.jooq

Package org.jooq.impl

Class DefaultDataType<T>

java.lang.Object

org.jooq.impl.DefaultDataType<T>

All Implemented Interfaces:

Serializable, DataType<T>

@Internal
public class DefaultDataType<T>
extends Object
implements DataType<T>

A common base class for data types.

This also acts as a static data type registry for jOOQ internally.

This type is for JOOQ INTERNAL USE only. Do not reference directly

Author:

Lukas Eder

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
DefaultDataType(SQLDialect dialect, Class<T> type, String typeName)
DefaultDataType(SQLDialect dialect, Class<T> type, String typeName, String castTypeName)
DefaultDataType(SQLDialect dialect, DataType<T> sqlDataType, String typeName)
DefaultDataType(SQLDialect dialect, DataType<T> sqlDataType, String typeName, String castTypeName)

Method Summary

Modifier and Type	Method	Description
<A extends ArrayRecord<?>> DataType<A>	asArrayDataType(Class<A> arrayDataType)	Retrieve the data type for an Oracle-style ARRAY of this data type.
<U> DataType<U>	asConvertedDataType(Binding<? super T,U> newBinding)	Retrieve the data type for a given binding.
<U> DataType<U>	asConvertedDataType(Converter<? super T,U> converter)	Retrieve the data type for a given converter.
<E extends EnumType> DataType<E>	asEnumDataType(Class<E> enumDataType)	Retrieve the data type for a given enum data type.
CharacterSet	characterSet()	Get the character set of this data type, or null if there is no character set, or if the default character set applies.
DataType<T>	characterSet(CharacterSet c)	Return a new data type like this, with a new character set.
Collation	collation()	Get the collation of this data type, or null if there is no collation, or if the default collation applies.
DataType<T>	collation(Collation c)	Return a new data type like this, with a new collation.
T	convert(Object object)	Convert an arbitrary object into <T>.
T[]	convert(Object... objects)	Convert an arbitrary set of objects into <T>.
List<T>	convert(Collection<?> objects)	Convert an arbitrary set of objects into <T>.
Field<T>	default_()	The expression to be applied as the DEFAULT value for this data type.
DataType<T>	default_(Field<T> d)	Specify an expression to be applied as the DEFAULT value for this data type.
DataType<T>	default_(T d)	Specify an expression to be applied as the DEFAULT value for this data type.
boolean	defaulted()	Get the defaultability of this data type.
DataType<T>	defaulted(boolean d)	Deprecated.
Field<T>	defaultValue()	The expression to be applied as the DEFAULT value for this data type.
DataType<T>	defaultValue(Field<T> d)	Specify an expression to be applied as the DEFAULT value for this data type.
DataType<T>	defaultValue(T d)	Specify an expression to be applied as the DEFAULT value for this data type.
boolean	equals(Object obj)
DataType<T[]>	getArrayDataType()	Retrieve the data type for an ARRAY of this data type.
Class<T[]>	getArrayType()	Retrieve the Java type associated with ARRAYs of this data type.
Binding<?,T>	getBinding()	Get the data type binding associated with this data type.
String	getCastTypeName()	Retrieve the dialect-specific type name associated with this data type used for casting.
String	getCastTypeName(Configuration configuration)	Retrieve the dialect-specific type name associated with this data type used for casting.
Converter<?,T>	getConverter()	Get the converter associated with this data type.
DataType<T>	getDataType(Configuration configuration)	The dialect-specific data type representing this data type.
static <T> DataType<T>	getDataType(SQLDialect dialect, Class<T> type)
static <T> DataType<T>	getDataType(SQLDialect dialect, Class<T> type, DataType<T> fallbackDataType)
static DataType<?>	getDataType(SQLDialect dialect, String typeName)
static DataType<?>	getDataType(SQLDialect dialect, String t, int p, int s)	Convert a type name (using precision and scale) into a Java class
static DataType<Object>	getDefaultDataType(String typeName)
static DataType<Object>	getDefaultDataType(SQLDialect dialect, String typeName)
SQLDialect	getDialect()	Retrieve the underlying SQLDialect.
DataType<T>	getSQLDataType()	Get the standard SQL data type of this (dialect-specific) data type if available.
int	getSQLType()	Get JDBC Types value.
int	getSQLType(Configuration configuration)	Get the dialect-specific JDBC Types value.
Class<T>	getType()	Retrieve the Java type associated with this data type.
static Class<?>	getType(SQLDialect dialect, String t, int p, int s)	Convert a type name (using precision and scale) into a Java class
String	getTypeName()	Retrieve the dialect-specific type name associated with this data type.
String	getTypeName(Configuration configuration)	Retrieve the dialect-specific type name associated with this data type.
int	hashCode()
boolean	hasLength()	Whether this data type has a length.
boolean	hasPrecision()	Whether this data type has a precision.
boolean	hasScale()	Whether this data type has a scale.
boolean	identity()	Get the identity flag of this data type.
DataType<T>	identity(boolean i)	Return a new data type like this, with a new identity flag.
boolean	isArray()	Whether this data type is an array type.
boolean	isBinary()	Whether this data type is any binary type.
boolean	isDate()	Whether this data type is any date type.
boolean	isDateTime()	Whether this data type is any date or time type.
boolean	isEnum()	Whether this data type is an enum type.
boolean	isInterval()	Whether this data type is any interval type.
boolean	isLob()	Whether this data type is best deserialised as a LOB.
boolean	isNumeric()	Whether this data type is any numeric data type.
boolean	isString()	Whether this data type is any character data type.
boolean	isTemporal()	Whether this data type is any date or time type.
boolean	isTime()	Whether this data type is any time type.
boolean	isTimestamp()	Whether this data type is any timestamp type.
boolean	isUDT()	Whether this data type is a UDT type.
int	length()	Get the length of this data type.
DataType<T>	length(int l)	Return a new data type like this, with a new length value.
static String	normalise(String typeName)
Nullability	nullability()	Get the nullability of this data type.
DataType<T>	nullability(Nullability n)	Return a new data type like this, with a new nullability.
boolean	nullable()	Get the nullability of this data type.
DataType<T>	nullable(boolean n)	Return a new data type like this, with a new nullability.
int	precision()	Get the precision of this data type.
DataType<T>	precision(int p)	Return a new data type like this, with a new precision value.
DataType<T>	precision(int p, int s)	Return a new data type like this, with a new precision and scale value.
int	scale()	Get the scale of this data type.
DataType<T>	scale(int s)	Return a new data type like this, with a new scale value.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultDataType

public DefaultDataType(SQLDialect dialect,
                       DataType<T> sqlDataType,
                       String typeName)

DefaultDataType

public DefaultDataType(SQLDialect dialect,
                       DataType<T> sqlDataType,
                       String typeName,
                       String castTypeName)

DefaultDataType

public DefaultDataType(SQLDialect dialect,
                       Class<T> type,
                       String typeName)

DefaultDataType

public DefaultDataType(SQLDialect dialect,
                       Class<T> type,
                       String typeName,
                       String castTypeName)

Method Detail

nullability

public final DataType<T> nullability(Nullability n)

Description copied from interface: DataType

Return a new data type like this, with a new nullability.

[#5709] A nullable column cannot have an DataType.identity().

Specified by:

nullability in interface DataType<T>

Parameters:

n - The new nullability

Returns:

The new data type

nullability

public final Nullability nullability()

Description copied from interface: DataType

Get the nullability of this data type.

Specified by:

nullability in interface DataType<T>

Returns:

The nullability

nullable

public final DataType<T> nullable(boolean n)

Description copied from interface: DataType

Return a new data type like this, with a new nullability.

This is the same as calling DataType.nullability(Nullability) with any of Nullability.NULL or Nullability.NOT_NULL as an argument.

[#5709] A nullable column cannot have an DataType.identity().

Specified by:

nullable in interface DataType<T>

Parameters:

n - The new nullability

Returns:

The new data type

nullable

public final boolean nullable()

Description copied from interface: DataType

Get the nullability of this data type.

This returns true by default, i.e. if DataType.nullability() is Nullability.DEFAULT.

Specified by:

nullable in interface DataType<T>

Returns:

The nullability

collation

public final DataType<T> collation(Collation c)

Description copied from interface: DataType

Return a new data type like this, with a new collation.

Specified by:

collation in interface DataType<T>

collation

public final Collation collation()

Description copied from interface: DataType

Get the collation of this data type, or null if there is no collation, or if the default collation applies.

Specified by:

collation in interface DataType<T>

characterSet

public final DataType<T> characterSet(CharacterSet c)

Description copied from interface: DataType

Return a new data type like this, with a new character set.

Specified by:

characterSet in interface DataType<T>

characterSet

public final CharacterSet characterSet()

Description copied from interface: DataType

Get the character set of this data type, or null if there is no character set, or if the default character set applies.

Specified by:

characterSet in interface DataType<T>

identity

public final DataType<T> identity(boolean i)

Description copied from interface: DataType

Return a new data type like this, with a new identity flag.

[#5709] The IDENTITY flag imposes a NOT NULL constraint, and removes all DEFAULT values.

Specified by:

identity in interface DataType<T>

Parameters:

i - The new identity flag

Returns:

The new data type

identity

public final boolean identity()

Description copied from interface: DataType

Get the identity flag of this data type.

Specified by:

identity in interface DataType<T>

Returns:

The identity flag.

defaultValue

public final DataType<T> defaultValue(T d)

Description copied from interface: DataType

Specify an expression to be applied as the DEFAULT value for this data type.

[#5709] A defaulted column cannot have an DataType.identity().

This is an alias for DataType.default_(Object).

Specified by:

defaultValue in interface DataType<T>

See Also:

DataType.defaultValue(Field)

defaultValue

public final DataType<T> defaultValue(Field<T> d)

Description copied from interface: DataType

Specify an expression to be applied as the DEFAULT value for this data type.

A default value of a data type applies to DDL statements, such as

• CREATE TABLE
• ALTER TABLE

The distinct types of possible DEFAULT expressions is defined by the underlying database. Please refer to your database manual to learn what expressions are possible.

This is an alias for DataType.default_(Field).

Specified by:

defaultValue in interface DataType<T>

defaultValue

public final Field<T> defaultValue()

Description copied from interface: DataType

The expression to be applied as the DEFAULT value for this data type.

This is an alias for DataType.default_().

Specified by:

defaultValue in interface DataType<T>

Returns:

The default value if present, or null if no default value is specified for this data type.

See Also:

DataType.defaultValue(Field)

default_

public final DataType<T> default_(T d)

Description copied from interface: DataType

Specify an expression to be applied as the DEFAULT value for this data type.

[#5709] A defaulted column cannot have an DataType.identity().

Specified by:

default_ in interface DataType<T>

See Also:

DataType.defaultValue(Field)

default_

public final DataType<T> default_(Field<T> d)

Description copied from interface: DataType

Specify an expression to be applied as the DEFAULT value for this data type.

A default value of a data type applies to DDL statements, such as

• CREATE TABLE
• ALTER TABLE

The distinct types of possible DEFAULT expressions is defined by the underlying database. Please refer to your database manual to learn what expressions are possible.

Specified by:

default_ in interface DataType<T>

default_

public final Field<T> default_()

Description copied from interface: DataType

The expression to be applied as the DEFAULT value for this data type.

Specified by:

default_ in interface DataType<T>

Returns:

The default value if present, or null if no default value is specified for this data type.

See Also:

DataType.defaultValue(Field)

defaulted

@Deprecated
public final DataType<T> defaulted(boolean d)

Deprecated.

Description copied from interface: DataType

Return a new data type like this, with a new defaultability.

Specified by:

defaulted in interface DataType<T>

Parameters:

d - The new defaultability

Returns:

The new data type

defaulted

public final boolean defaulted()

Description copied from interface: DataType

Get the defaultability of this data type.

Specified by:

defaulted in interface DataType<T>

Returns:

The defaultability

precision

public final DataType<T> precision(int p)

Description copied from interface: DataType

Return a new data type like this, with a new precision value.

This will have no effect if DataType.hasPrecision() is false

This is the same as calling DataType.precision(int, int) with scale == 0

Specified by:

precision in interface DataType<T>

Parameters:

p - The new precision value

Returns:

The new data type

precision

public final DataType<T> precision(int p,
                                   int s)

Description copied from interface: DataType

Return a new data type like this, with a new precision and scale value.

This will have no effect if DataType.hasPrecision() is false , or if scale > 0 and DataType.hasScale() is false

Specified by:

precision in interface DataType<T>

Parameters:

p - The new precision value

s - The new scale value

Returns:

The new data type

precision

public final int precision()

Description copied from interface: DataType

Get the precision of this data type.

Specified by:

precision in interface DataType<T>

Returns:

The precision of this data type

hasPrecision

public final boolean hasPrecision()

Description copied from interface: DataType

Whether this data type has a precision.

Specified by:

hasPrecision in interface DataType<T>

Returns:

Whether this data type has a precision

scale

public final DataType<T> scale(int s)

Description copied from interface: DataType

Return a new data type like this, with a new scale value.

This will have no effect if DataType.hasScale() is false

Specified by:

scale in interface DataType<T>

Parameters:

s - The new scale value

Returns:

The new data type

scale

public final int scale()

Description copied from interface: DataType

Get the scale of this data type.

Specified by:

scale in interface DataType<T>

Returns:

The scale of this data type

hasScale

public final boolean hasScale()

Description copied from interface: DataType

Whether this data type has a scale.

Specified by:

hasScale in interface DataType<T>

Returns:

Whether this data type has a scale

length

public final DataType<T> length(int l)

Description copied from interface: DataType

Return a new data type like this, with a new length value.

This will have no effect if DataType.hasLength() is false

Specified by:

length in interface DataType<T>

Parameters:

l - The new length value

Returns:

The new data type

length

public final int length()

Description copied from interface: DataType

Get the length of this data type.

Specified by:

length in interface DataType<T>

Returns:

The length of this data type

hasLength

public final boolean hasLength()

Description copied from interface: DataType

Whether this data type has a length.

Specified by:

hasLength in interface DataType<T>

Returns:

Whether this data type has a length

getSQLDataType

public final DataType<T> getSQLDataType()

Description copied from interface: DataType

Get the standard SQL data type of this (dialect-specific) data type if available.

Specified by:

getSQLDataType in interface DataType<T>

getDataType

public final DataType<T> getDataType(Configuration configuration)

Description copied from interface: DataType

The dialect-specific data type representing this data type.

Specified by:

getDataType in interface DataType<T>

getSQLType

public int getSQLType()

Description copied from interface: DataType

Get JDBC Types value.

Specified by:

getSQLType in interface DataType<T>

getSQLType

public final int getSQLType(Configuration configuration)

Description copied from interface: DataType

Get the dialect-specific JDBC Types value.

Specified by:

getSQLType in interface DataType<T>

getType

public final Class<T> getType()

Description copied from interface: DataType

Retrieve the Java type associated with this data type.

Specified by:

getType in interface DataType<T>

getBinding

public final Binding<?,T> getBinding()

Description copied from interface: DataType

Get the data type binding associated with this data type.

Specified by:

getBinding in interface DataType<T>

getConverter

public final Converter<?,T> getConverter()

Description copied from interface: DataType

Get the converter associated with this data type.

Specified by:

getConverter in interface DataType<T>

getArrayType

public final Class<T[]> getArrayType()

Description copied from interface: DataType

Retrieve the Java type associated with ARRAYs of this data type.

Specified by:

getArrayType in interface DataType<T>

getTypeName

public final String getTypeName()

Description copied from interface: DataType

Retrieve the dialect-specific type name associated with this data type.

Specified by:

getTypeName in interface DataType<T>

getTypeName

public String getTypeName(Configuration configuration)

Description copied from interface: DataType

Retrieve the dialect-specific type name associated with this data type.

Specified by:

getTypeName in interface DataType<T>

getCastTypeName

public final String getCastTypeName()

Description copied from interface: DataType

Retrieve the dialect-specific type name associated with this data type used for casting.

This is useful for some dialects that have specialised type names for cast expressions. Other dialects require type-length binding when casting, (e.g. VARCHAR(32767))

Specified by:

getCastTypeName in interface DataType<T>

getCastTypeName

public String getCastTypeName(Configuration configuration)

Description copied from interface: DataType

Retrieve the dialect-specific type name associated with this data type used for casting.

This is useful for some dialects that have specialised type names for cast expressions. Other dialects require type-length binding when casting, (e.g. VARCHAR(32767))

Specified by:

getCastTypeName in interface DataType<T>

getArrayDataType

public final DataType<T[]> getArrayDataType()

Description copied from interface: DataType

Retrieve the data type for an ARRAY of this data type.

Specified by:

getArrayDataType in interface DataType<T>

asArrayDataType

@Pro
public final <A extends ArrayRecord<?>> DataType<A> asArrayDataType(Class<A> arrayDataType)

Description copied from interface: DataType

Retrieve the data type for an Oracle-style ARRAY of this data type.

Specified by:

asArrayDataType in interface DataType<T>

asEnumDataType

public final <E extends EnumType> DataType<E> asEnumDataType(Class<E> enumDataType)

Description copied from interface: DataType

Retrieve the data type for a given enum data type.

Specified by:

asEnumDataType in interface DataType<T>

asConvertedDataType

public <U> DataType<U> asConvertedDataType(Converter<? super T,U> converter)

Description copied from interface: DataType

Retrieve the data type for a given converter.

Specified by:

asConvertedDataType in interface DataType<T>

asConvertedDataType

public <U> DataType<U> asConvertedDataType(Binding<? super T,U> newBinding)

Description copied from interface: DataType

Retrieve the data type for a given binding.

Specified by:

asConvertedDataType in interface DataType<T>

getDialect

public final SQLDialect getDialect()

Description copied from interface: DataType

Retrieve the underlying SQLDialect.

Specified by:

getDialect in interface DataType<T>

convert

public T convert(Object object)

Description copied from interface: DataType

Convert an arbitrary object into <T>.

See Convert.convert(Object, Class) for details about conversion rules.

Specified by:

convert in interface DataType<T>

Parameters:

object - The object to be converted

Returns:

The converted object

convert

public final T[] convert(Object... objects)

Description copied from interface: DataType

Convert an arbitrary set of objects into <T>.

See Convert.convert(Object, Class) for details about conversion rules.

Specified by:

convert in interface DataType<T>

Parameters:

objects - The objects to be converted

Returns:

The converted objects

convert

public final List<T> convert(Collection<?> objects)

Description copied from interface: DataType

Convert an arbitrary set of objects into <T>.

See Convert.convert(Object, Class) for details about conversion rules.

Specified by:

convert in interface DataType<T>

Parameters:

objects - The objects to be converted

Returns:

The converted objects

getDefaultDataType

public static final DataType<Object> getDefaultDataType(String typeName)

getDefaultDataType

public static final DataType<Object> getDefaultDataType(SQLDialect dialect,
                                                        String typeName)

getDataType

public static final DataType<?> getDataType(SQLDialect dialect,
                                            String typeName)

getDataType

public static final <T> DataType<T> getDataType(SQLDialect dialect,
                                                Class<T> type)

getDataType

public static final <T> DataType<T> getDataType(SQLDialect dialect,
                                                Class<T> type,
                                                DataType<T> fallbackDataType)

isNumeric

public final boolean isNumeric()

Description copied from interface: DataType

Whether this data type is any numeric data type.

This applies to any of these types:

• SQLDataType.TINYINT
• SQLDataType.SMALLINT
• SQLDataType.INTEGER
• SQLDataType.BIGINT
• SQLDataType.FLOAT
• SQLDataType.DOUBLE
• SQLDataType.REAL
• SQLDataType.DECIMAL
• SQLDataType.DECIMAL_INTEGER
• SQLDataType.NUMERIC

Specified by:

isNumeric in interface DataType<T>

isString

public final boolean isString()

Description copied from interface: DataType

Whether this data type is any character data type.

This applies to any of these types:

• SQLDataType.CHAR
• SQLDataType.CLOB
• SQLDataType.LONGNVARCHAR
• SQLDataType.LONGVARCHAR
• SQLDataType.NCHAR
• SQLDataType.NCLOB
• SQLDataType.NVARCHAR
• SQLDataType.VARCHAR

Specified by:

isString in interface DataType<T>

isDateTime

public final boolean isDateTime()

Description copied from interface: DataType

Whether this data type is any date or time type.

This applies to any of these types.

• SQLDataType.DATE
• SQLDataType.TIME
• SQLDataType.TIMESTAMP
• SQLDataType.LOCALDATE
• SQLDataType.LOCALTIME
• SQLDataType.LOCALDATETIME
• SQLDataType.OFFSETTIME
• SQLDataType.OFFSETDATETIME
• SQLDataType.INSTANT

Specified by:

isDateTime in interface DataType<T>

See Also:

DataType.isDate()

isDate

public final boolean isDate()

Description copied from interface: DataType

Whether this data type is any date type.

This applies to any of these types.

• SQLDataType.DATE
• SQLDataType.LOCALDATE

Specified by:

isDate in interface DataType<T>

isTimestamp

public final boolean isTimestamp()

Description copied from interface: DataType

Whether this data type is any timestamp type.

This applies to any of these types.

• SQLDataType.TIMESTAMP
• SQLDataType.LOCALDATETIME

Specified by:

isTimestamp in interface DataType<T>

isTime

public final boolean isTime()

Description copied from interface: DataType

Whether this data type is any time type.

This applies to any of these types.

• SQLDataType.TIME
• SQLDataType.LOCALTIME

Specified by:

isTime in interface DataType<T>

isTemporal

public final boolean isTemporal()

Description copied from interface: DataType

Whether this data type is any date or time type.

This applies to any of these types.

• SQLDataType.DATE
• SQLDataType.TIME
• SQLDataType.TIMESTAMP
• SQLDataType.LOCALDATE
• SQLDataType.LOCALTIME
• SQLDataType.LOCALDATETIME
• SQLDataType.OFFSETTIME
• SQLDataType.OFFSETDATETIME
• YearToSecond
• YearToMonth
• DayToSecond

This is a combination of DataType.isDateTime() or DataType.isInterval()

Specified by:

isTemporal in interface DataType<T>

isInterval

public final boolean isInterval()

Description copied from interface: DataType

Whether this data type is any interval type.

This applies to any of these types.

• YearToSecond
• YearToMonth
• DayToSecond

Specified by:

isInterval in interface DataType<T>

isLob

public final boolean isLob()

Description copied from interface: DataType

Whether this data type is best deserialised as a LOB.

This applies to any of these types.

• SQLDataType.BLOB
• SQLDataType.CLOB
• SQLDataType.NCLOB

Specified by:

isLob in interface DataType<T>

isBinary

public final boolean isBinary()

Description copied from interface: DataType

Whether this data type is any binary type.

This applies to any of these types.

• SQLDataType.BINARY
• SQLDataType.BLOB
• SQLDataType.LONGVARBINARY
• SQLDataType.VARBINARY

Specified by:

isBinary in interface DataType<T>

isArray

public final boolean isArray()

Description copied from interface: DataType

Whether this data type is an array type.

Specified by:

isArray in interface DataType<T>

isUDT

public final boolean isUDT()

Description copied from interface: DataType

Whether this data type is a UDT type.

Specified by:

isUDT in interface DataType<T>

isEnum

public final boolean isEnum()

Description copied from interface: DataType

Whether this data type is an enum type.

Specified by:

isEnum in interface DataType<T>

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

normalise

public static final String normalise(String typeName)

Returns:

The type name without all special characters and white spaces

getDataType

public static final DataType<?> getDataType(SQLDialect dialect,
                                            String t,
                                            int p,
                                            int s)
                                     throws SQLDialectNotSupportedException

Convert a type name (using precision and scale) into a Java class

Throws:

SQLDialectNotSupportedException

getType

public static final Class<?> getType(SQLDialect dialect,
                                     String t,
                                     int p,
                                     int s)
                              throws SQLDialectNotSupportedException

Convert a type name (using precision and scale) into a Java class

Throws:

SQLDialectNotSupportedException