Record Class TemporalTableAuxiliaryObject

java.lang.Object

java.lang.Record

org.hibernate.dialect.temporal.spi.TemporalTableAuxiliaryObject

Record Components:

exportIdentifier - the stable descriptor identifier within its scope

scope - whether the descriptor is shared or belongs to one table

beforeTables - whether creation precedes table creation

createCommands - the ordered creation commands

dropCommands - the ordered drop commands

@SPI(USE)
public record TemporalTableAuxiliaryObject(String exportIdentifier, TemporalTableAuxiliaryObject.Scope scope, boolean beforeTables, List<String> createCommands, List<String> dropCommands)
extends Record

Declares ordered schema commands required by a temporal table strategy.

Database-scoped descriptors are deduplicated by export identifier. Table- scoped descriptors are isolated by table name plus export identifier. Command lists are immutable snapshots and at least one command is required.

Since:

8.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TemporalTableAuxiliaryObject.Scope	Defines whether an auxiliary object is shared by the database or belongs to one temporal table.

Constructor Summary

Constructors

Constructor	Description
TemporalTableAuxiliaryObject(String exportIdentifier, TemporalTableAuxiliaryObject.Scope scope, boolean beforeTables, List<String> createCommands, List<String> dropCommands)	Creates an instance of a TemporalTableAuxiliaryObject record class.

Method Summary

Modifier and Type	Method	Description
boolean	beforeTables()	Returns the value of the beforeTables record component.
List<String>	createCommands()	Returns the value of the createCommands record component.
List<String>	dropCommands()	Returns the value of the dropCommands record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	exportIdentifier()	Returns the value of the exportIdentifier record component.
final int	hashCode()	Returns a hash code value for this object.
TemporalTableAuxiliaryObject.Scope	scope()	Returns the value of the scope record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

TemporalTableAuxiliaryObject

public TemporalTableAuxiliaryObject(String exportIdentifier,
 TemporalTableAuxiliaryObject.Scope scope,
 boolean beforeTables,
 List<String> createCommands,
 List<String> dropCommands)

Creates an instance of a TemporalTableAuxiliaryObject record class.

Parameters:

exportIdentifier - the value for the exportIdentifier record component

scope - the value for the scope record component

beforeTables - the value for the beforeTables record component

createCommands - the value for the createCommands record component

dropCommands - the value for the dropCommands record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

exportIdentifier

public String exportIdentifier()

Returns the value of the exportIdentifier record component.

Returns:

the value of the exportIdentifier record component

scope

public TemporalTableAuxiliaryObject.Scope scope()

Returns the value of the scope record component.

Returns:

the value of the scope record component

beforeTables

public boolean beforeTables()

Returns the value of the beforeTables record component.

Returns:

the value of the beforeTables record component

createCommands

public List<String> createCommands()

Returns the value of the createCommands record component.

Returns:

the value of the createCommands record component

dropCommands

public List<String> dropCommands()

Returns the value of the dropCommands record component.

Returns:

the value of the dropCommands record component