Package org.hibernate.tuple

Enum GenerationTiming

java.lang.Object

java.lang.Enum<GenerationTiming>

org.hibernate.tuple.GenerationTiming

All Implemented Interfaces:

Serializable, Comparable<GenerationTiming>

@Deprecated(since="6",
            forRemoval=true)
public enum GenerationTiming
extends Enum<GenerationTiming>

Deprecated, for removal: This API element is subject to removal in a future version.

Replaced by EventType as id-generation has been redefined using the new broader generation approach.

Represents the timing of value generation that occurs in the Java program, or in the database.

See Also:

ValueGeneration

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALWAYS	Deprecated, for removal: This API element is subject to removal in a future version. Value generation that occurs when a row is inserted or updated in the database.
INSERT	Deprecated, for removal: This API element is subject to removal in a future version. Value generation that occurs when a row is inserted in the database.
NEVER	Deprecated, for removal: This API element is subject to removal in a future version. Value generation that never occurs.
UPDATE	Deprecated, for removal: This API element is subject to removal in a future version. Value generation that occurs when a row is updated in the database.

Method Summary

Modifier and Type	Method	Description
GenerationTime	getEquivalent()	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	includes(GenerationTiming timing)	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	includesInsert()	Deprecated, for removal: This API element is subject to removal in a future version. Does value generation happen for SQL insert statements?
boolean	includesUpdate()	Deprecated, for removal: This API element is subject to removal in a future version. Does value generation happen for SQL update statements?
static GenerationTiming	parseFromName(String name)	Deprecated, for removal: This API element is subject to removal in a future version.
static GenerationTiming	valueOf(String name)	Deprecated, for removal: This API element is subject to removal in a future version. Returns the enum constant of this type with the specified name.
static GenerationTiming[]	values()	Deprecated, for removal: This API element is subject to removal in a future version. 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

NEVER

public static final GenerationTiming NEVER

Deprecated, for removal: This API element is subject to removal in a future version.

Value generation that never occurs.

INSERT

public static final GenerationTiming INSERT

Deprecated, for removal: This API element is subject to removal in a future version.

Value generation that occurs when a row is inserted in the database.

UPDATE

public static final GenerationTiming UPDATE

Deprecated, for removal: This API element is subject to removal in a future version.

Value generation that occurs when a row is updated in the database.

ALWAYS

public static final GenerationTiming ALWAYS

Deprecated, for removal: This API element is subject to removal in a future version.

Value generation that occurs when a row is inserted or updated in the database.

Method Detail

values

public static GenerationTiming[] values()

Deprecated, for removal: This API element is subject to removal in a future version.

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 (GenerationTiming c : GenerationTiming.values())
    System.out.println(c);

Returns:

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

valueOf

public static GenerationTiming valueOf(String name)

Deprecated, for removal: This API element is subject to removal in a future version.

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

includesInsert

public boolean includesInsert()

Deprecated, for removal: This API element is subject to removal in a future version.

Does value generation happen for SQL insert statements?

includesUpdate

public boolean includesUpdate()

Deprecated, for removal: This API element is subject to removal in a future version.

Does value generation happen for SQL update statements?

includes

public boolean includes(GenerationTiming timing)

Deprecated, for removal: This API element is subject to removal in a future version.

parseFromName

public static GenerationTiming parseFromName(String name)

Deprecated, for removal: This API element is subject to removal in a future version.

getEquivalent

public GenerationTime getEquivalent()

Deprecated, for removal: This API element is subject to removal in a future version.

Returns:

the equivalent instance of GenerationTime