Module org.jooq

Package org.jooq

Enum Class Nullability

java.lang.Object

java.lang.Enum<Nullability>

org.jooq.Nullability

All Implemented Interfaces:

Serializable, Comparable<Nullability>, Constable

public enum Nullability
extends Enum<Nullability>

An enum that specifies the nullability of a DataType.

Author:

Lukas Eder

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
DEFAULT	Default behaviour for data types.
NOT_NULL	The data type is explicitly not nullable.
NULL	The data type is explicitly nullable.

Method Summary

Modifier and Type	Method	Description
boolean	nullable()	Whether this nullability encodes an explicitly or implicitly nullable type.
static @NotNull Nullability	of(boolean nullability)	Get the explicit Nullability corresponding to a boolean value.
static Nullability	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Nullability[]	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

@NotNull
@Support
public static final Nullability NULL

The data type is explicitly nullable.

NOT_NULL

@NotNull
@Support
public static final Nullability NOT_NULL

The data type is explicitly not nullable.

DEFAULT

@NotNull
@Support
public static final Nullability DEFAULT

Default behaviour for data types.

The interpretation of this value depends on the context in which a DataType is used:

• CREATE TABLE: The data type is implicitly nullable (or explicitly, if the underlying database does not support implicit nullability or defaults to implicit non-nullability).
• ALTER TABLE … ALTER COLUMN … SET TYPE: The data type's nullability will not be modified by jOOQ (but it may well be modified by the database, e.g. SQLDialect.MYSQL or SQLDialect.SQLSERVER).

Method Details

values

public static Nullability[] 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 Nullability 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

of

@NotNull
public static @NotNull Nullability of(boolean nullability)

Get the explicit Nullability corresponding to a boolean value.

nullable

public boolean nullable()

Whether this nullability encodes an explicitly or implicitly nullable type.