Record Class PlanningOptions

java.lang.Object

java.lang.Record

org.hibernate.action.queue.spi.PlanningOptions

All Implemented Interfaces:

Serializable

@Incubating
public record PlanningOptions(boolean orderByForeignKeys, boolean orderByUniqueKeySlots, boolean avoidBreakingDeferrable, boolean ignoreDeferrableForOrdering, PlanningOptions.UniqueCycleStrategy uniqueCycleStrategy)
extends Record
implements Serializable

Options for controlling operation planning and scheduling.

Since:

8.0

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PlanningOptions.UniqueCycleStrategy

Constructor Summary

Constructors

Constructor	Description
PlanningOptions(boolean orderByForeignKeys, boolean orderByUniqueKeySlots, boolean avoidBreakingDeferrable, boolean ignoreDeferrableForOrdering, PlanningOptions.UniqueCycleStrategy uniqueCycleStrategy)	Creates an instance of a PlanningOptions record class.

Method Summary

Modifier and Type	Method	Description
boolean	avoidBreakingDeferrable()	Returns the value of the avoidBreakingDeferrable record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
boolean	ignoreDeferrableForOrdering()	Returns the value of the ignoreDeferrableForOrdering record component.
boolean	orderByForeignKeys()	Returns the value of the orderByForeignKeys record component.
boolean	orderByUniqueKeySlots()	Returns the value of the orderByUniqueKeySlots record component.
final String	toString()	Returns a string representation of this record class.
PlanningOptions.UniqueCycleStrategy	uniqueCycleStrategy()	Returns the value of the uniqueCycleStrategy record component.

Methods inherited from class Object

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

Constructor Details

PlanningOptions

public PlanningOptions(boolean orderByForeignKeys,
 boolean orderByUniqueKeySlots,
 boolean avoidBreakingDeferrable,
 boolean ignoreDeferrableForOrdering,
 PlanningOptions.UniqueCycleStrategy uniqueCycleStrategy)

Creates an instance of a PlanningOptions record class.

Parameters:

orderByForeignKeys - the value for the orderByForeignKeys record component

orderByUniqueKeySlots - the value for the orderByUniqueKeySlots record component

avoidBreakingDeferrable - the value for the avoidBreakingDeferrable record component

ignoreDeferrableForOrdering - the value for the ignoreDeferrableForOrdering record component

uniqueCycleStrategy - the value for the uniqueCycleStrategy 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.

orderByForeignKeys

public boolean orderByForeignKeys()

Returns the value of the orderByForeignKeys record component.

Returns:

the value of the orderByForeignKeys record component

orderByUniqueKeySlots

public boolean orderByUniqueKeySlots()

Returns the value of the orderByUniqueKeySlots record component.

Returns:

the value of the orderByUniqueKeySlots record component

avoidBreakingDeferrable

public boolean avoidBreakingDeferrable()

Returns the value of the avoidBreakingDeferrable record component.

Returns:

the value of the avoidBreakingDeferrable record component

ignoreDeferrableForOrdering

public boolean ignoreDeferrableForOrdering()

Returns the value of the ignoreDeferrableForOrdering record component.

Returns:

the value of the ignoreDeferrableForOrdering record component

uniqueCycleStrategy

public PlanningOptions.UniqueCycleStrategy uniqueCycleStrategy()

Returns the value of the uniqueCycleStrategy record component.

Returns:

the value of the uniqueCycleStrategy record component