Hibernate ORM - hibernate-core 6.4.4.Final · org.hibernate.tuple.CreationTimestampGeneration

Modifier and Type	Field and Description
private ValueGenerator<?>	generator Deprecated as a consequence of `ValueGenerator` being deprecated.

Access	Constructor and Description
public	CreationTimestampGeneration()

Method Summary

Modifier and Type	Method and Description
public String	getDatabaseGeneratedReferencedColumnValue() Implements org.hibernate.tuple.ValueGeneration.getDatabaseGeneratedReferencedColumnValue. A SQL expression indicating how to calculate the generated value when the property value is generated in the database and the mapped column is included in the SQL statement.
public String	getDatabaseGeneratedReferencedColumnValue(Dialect The SQL dialect, allowing generation of an expression in dialect-specific SQL. dialect) Overrides default org.hibernate.tuple.ValueGeneration.getDatabaseGeneratedReferencedColumnValue. A SQL expression indicating how to calculate the generated value when the property value is generated in the database and the mapped column is included in the SQL statement.
public GenerationTiming	getGenerationTiming() Implements org.hibernate.tuple.ValueGeneration.getGenerationTiming. Deprecated as a consequence of `GenerationTiming` being deprecated. Specifies that the property value is generated: when the entity is inserted, when the entity is updated, whenever the entity is inserted or updated, or never.
public ValueGenerator<?>	getValueGenerator() Implements org.hibernate.tuple.ValueGeneration.getValueGenerator. Deprecated as a consequence of `ValueGenerator` being deprecated. Obtain the Java value generator, if the value is generated in Java, or return `null` if the value is generated by the database.
public void	initialize(CreationTimestamp an instance of the strategy's annotation type. Typically, implementations will retrieve the annotation's attribute values and store them in fields. annotation, Class<?> the type of the property annotated with the generator annotation. propertyType) Implements org.hibernate.tuple.AnnotationValueGeneration.initialize. Initializes this generation strategy for the given annotation instance.
public boolean	referenceColumnInSql() Implements org.hibernate.tuple.ValueGeneration.referenceColumnInSql. Determines if the column whose value is generated is included in the column list of the SQL `insert` or `update` statement, in the case where the value is generated by the database.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

generator	back to summary
private ValueGenerator<?> generator Deprecated as a consequence of `ValueGenerator` being deprecated. See corresponding docs for further information.

CreationTimestampGeneration	back to summary
public CreationTimestampGeneration()

Method Detail

getDatabaseGeneratedReferencedColumnValue back to summary

getDatabaseGeneratedReferencedColumnValue	back to summary
public String getDatabaseGeneratedReferencedColumnValue() Implements org.hibernate.tuple.ValueGeneration.getDatabaseGeneratedReferencedColumnValue. Doc from org.hibernate.tuple.ValueGeneration.getDatabaseGeneratedReferencedColumnValue. A SQL expression indicating how to calculate the generated value when the property value is generated in the database and the mapped column is included in the SQL statement. The SQL expression might be: a function call like `current_timestamp` or `nextval('mysequence')`, or a syntactic marker like `default`. When the property value is generated in Java, this method is not called, and its value is implicitly the string `"?"`, that is, a JDBC parameter to which the generated value is bound. Returns:String The column value to be used in the generated SQL statement. Annotations @Override

public String getDatabaseGeneratedReferencedColumnValue()

Implements org.hibernate.tuple.ValueGeneration.getDatabaseGeneratedReferencedColumnValue.

Doc from org.hibernate.tuple.ValueGeneration.getDatabaseGeneratedReferencedColumnValue.

A SQL expression indicating how to calculate the generated value when the property value is generated in the database and the mapped column is included in the SQL statement. The SQL expression might be:

a function call like current_timestamp or nextval('mysequence'), or
a syntactic marker like default.

When the property value is generated in Java, this method is not called, and its value is implicitly the string "?", that is, a JDBC parameter to which the generated value is bound.

Returns:String

The column value to be used in the generated SQL statement.

Annotations

@Override

getDatabaseGeneratedReferencedColumnValue back to summary

getDatabaseGeneratedReferencedColumnValue	back to summary
public String getDatabaseGeneratedReferencedColumnValue(Dialect dialect) Overrides default org.hibernate.tuple.ValueGeneration.getDatabaseGeneratedReferencedColumnValue. Doc from org.hibernate.tuple.ValueGeneration.getDatabaseGeneratedReferencedColumnValue. A SQL expression indicating how to calculate the generated value when the property value is generated in the database and the mapped column is included in the SQL statement. The SQL expression might be: a function call like `current_timestamp` or `nextval('mysequence')`, or a syntactic marker like `default`. When the property value is generated in Java, this method is not called, and its value is implicitly the string `"?"`, that is, a JDBC parameter to which the generated value is bound. Parameters dialect:Dialect The SQL dialect, allowing generation of an expression in dialect-specific SQL. Returns:String The column value to be used in the generated SQL statement. Annotations @Override

public String getDatabaseGeneratedReferencedColumnValue(Dialect dialect)

Overrides default org.hibernate.tuple.ValueGeneration.getDatabaseGeneratedReferencedColumnValue.

Doc from org.hibernate.tuple.ValueGeneration.getDatabaseGeneratedReferencedColumnValue.

a function call like current_timestamp or nextval('mysequence'), or
a syntactic marker like default.

When the property value is generated in Java, this method is not called, and its value is implicitly the string "?", that is, a JDBC parameter to which the generated value is bound.

Parameters

dialect:Dialect: The SQL dialect, allowing generation of an expression in dialect-specific SQL.

Returns:String

The column value to be used in the generated SQL statement.

Annotations

@Override

getGenerationTiming back to summary

getGenerationTiming	back to summary
public GenerationTiming getGenerationTiming() Implements org.hibernate.tuple.ValueGeneration.getGenerationTiming. Doc from org.hibernate.tuple.ValueGeneration.getGenerationTiming. Deprecated as a consequence of `GenerationTiming` being deprecated. See corresponding docs for further information. Specifies that the property value is generated: when the entity is inserted, when the entity is updated, whenever the entity is inserted or updated, or never. Returns:GenerationTiming The `GenerationTiming` specifying when the value is generated. Annotations @Override

public GenerationTiming getGenerationTiming()

Implements org.hibernate.tuple.ValueGeneration.getGenerationTiming.

Doc from org.hibernate.tuple.ValueGeneration.getGenerationTiming.

Deprecated

as a consequence of GenerationTiming being deprecated. See corresponding docs for further information.

Specifies that the property value is generated:

Returns:GenerationTiming

The GenerationTiming specifying when the value is generated.

Annotations

@Override

getValueGenerator back to summary

getValueGenerator	back to summary
public ValueGenerator<?> getValueGenerator() Implements org.hibernate.tuple.ValueGeneration.getValueGenerator. Doc from org.hibernate.tuple.ValueGeneration.getValueGenerator. Deprecated as a consequence of `ValueGenerator` being deprecated. See corresponding docs for further information. Obtain the Java value generator, if the value is generated in Java, or return `null` if the value is generated by the database. Returns:ValueGenerator<?> The value generator Annotations @Override

public ValueGenerator<?> getValueGenerator()

Implements org.hibernate.tuple.ValueGeneration.getValueGenerator.

Doc from org.hibernate.tuple.ValueGeneration.getValueGenerator.

Deprecated

as a consequence of ValueGenerator being deprecated. See corresponding docs for further information.

Obtain the Java value generator, if the value is generated in Java, or return null if the value is generated by the database.

Returns:ValueGenerator<?>

The value generator

Annotations

@Override

initialize	back to summary
public void initialize(CreationTimestamp annotation, Class<?> propertyType) Implements org.hibernate.tuple.AnnotationValueGeneration.initialize. Doc from org.hibernate.tuple.AnnotationValueGeneration.initialize. Initializes this generation strategy for the given annotation instance. Parameters annotation:CreationTimestamp an instance of the strategy's annotation type. Typically, implementations will retrieve the annotation's attribute values and store them in fields. propertyType:Class<?> the type of the property annotated with the generator annotation. Annotations @Override

initialize

back to summary

public void initialize(CreationTimestamp annotation, Class<?> propertyType)

Implements org.hibernate.tuple.AnnotationValueGeneration.initialize.

Doc from org.hibernate.tuple.AnnotationValueGeneration.initialize.

Initializes this generation strategy for the given annotation instance.

Parameters

annotation:CreationTimestamp: an instance of the strategy's annotation type. Typically, implementations will retrieve the annotation's attribute values and store them in fields.
propertyType:Class<?>: the type of the property annotated with the generator annotation.

Annotations

@Override

referenceColumnInSql back to summary

referenceColumnInSql	back to summary
public boolean referenceColumnInSql() Implements org.hibernate.tuple.ValueGeneration.referenceColumnInSql. Doc from org.hibernate.tuple.ValueGeneration.referenceColumnInSql. Determines if the column whose value is generated is included in the column list of the SQL `insert` or `update` statement, in the case where the value is generated by the database. For example, this method should return: `true` if the value is generated by calling a SQL function like `current_timestamp`, or `false` if the value is generated by a trigger, by `generated always as`, or using a column default value. If the value is generated in Java, this method is not called, and so for backward compatibility with Hibernate 5 it is permitted to return any value. On the other hand, when a property value is generated in Java, the column certainly must be included in the column list, and so it's most correct for this method to return `true`! Returns:boolean `true` if the column is included in the column list of the SQL statement. Annotations @Override

public boolean referenceColumnInSql()

Implements org.hibernate.tuple.ValueGeneration.referenceColumnInSql.

Doc from org.hibernate.tuple.ValueGeneration.referenceColumnInSql.

Determines if the column whose value is generated is included in the column list of the SQL insert or update statement, in the case where the value is generated by the database. For example, this method should return:

true if the value is generated by calling a SQL function like current_timestamp, or
false if the value is generated by a trigger, by generated always as, or using a column default value.

If the value is generated in Java, this method is not called, and so for backward compatibility with Hibernate 5 it is permitted to return any value. On the other hand, when a property value is generated in Java, the column certainly must be included in the column list, and so it's most correct for this method to return true!

Returns:boolean

true if the column is included in the column list of the SQL statement.

Annotations

@Override

public Class CreationTimestampGeneration

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail