Module org.jooq

Package org.jooq

Enum Class GeneratorStatementType

java.lang.Object

java.lang.Enum<GeneratorStatementType>

org.jooq.GeneratorStatementType

All Implemented Interfaces:

Serializable, Comparable<GeneratorStatementType>, Constable

public enum GeneratorStatementType
extends Enum<GeneratorStatementType>

The statement type of a GeneratorContext.

Generator implementations may choose to execute different logic based on the statement type. One example are AuditProvider fields, which can distinguish between audit information on inserted or updated records.

This API is part of a commercial only feature. To use this feature, please use the jOOQ Professional Edition or the jOOQ Enterprise Edition.

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
INSERT	The Generator is being invoked in an Insert context, or in a Merge's INSERT clause context.
SELECT	The Generator is being invoked in a Select context, or an Insert's, Update's, or Delete's RETURNING clause context.
UPDATE	The Generator is being invoked in an Update context, or in an Insert's ON DUPLICATE KEY UPDATE clause, ON CONFLICT DO UPDATE clause context, or in a Merge's UPDATE clause context.

Method Summary

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

INSERT

public static final GeneratorStatementType INSERT

The Generator is being invoked in an Insert context, or in a Merge's INSERT clause context.

This applies to QOM.GenerationOption.STORED only.

UPDATE

public static final GeneratorStatementType UPDATE

The Generator is being invoked in an Update context, or in an Insert's ON DUPLICATE KEY UPDATE clause, ON CONFLICT DO UPDATE clause context, or in a Merge's UPDATE clause context.

This applies to QOM.GenerationOption.STORED only.

SELECT

public static final GeneratorStatementType SELECT

The Generator is being invoked in a Select context, or an Insert's, Update's, or Delete's RETURNING clause context.

This applies to QOM.GenerationOption.VIRTUAL only.

Method Details

values

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