Record Class FetchOptions

java.lang.Object

java.lang.Record

org.hibernate.engine.spi.FetchOptions

All Implemented Interfaces:

Serializable

public record FetchOptions(@Nullable CacheStoreMode cacheStoreMode, @Nullable CacheRetrieveMode cacheRetrieveMode, @Nullable Integer batchSize, @Nullable FetchMethod fetchMethod)
extends Record
implements Serializable

Fetch options applied to a particular association fetch.

Since:

6.0

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final FetchOptions	NONE

Constructor Summary

Constructors

Constructor	Description
FetchOptions(CacheStoreMode cacheStoreMode, CacheRetrieveMode cacheRetrieveMode, Integer batchSize, FetchMethod fetchMethod)	Creates an instance of a FetchOptions record class.

Method Summary

Modifier and Type	Method	Description
Integer	batchSize()	Returns the value of the batchSize record component.
CacheRetrieveMode	cacheRetrieveMode()	Returns the value of the cacheRetrieveMode record component.
CacheStoreMode	cacheStoreMode()	Returns the value of the cacheStoreMode record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
FetchMethod	fetchMethod()	Returns the value of the fetchMethod record component.
boolean	hasBatchSize()
boolean	hasCacheModes()
final int	hashCode()	Returns a hash code value for this object.
boolean	hasOptions()
static FetchOptions	of(AttributeNode<?> node)
static FetchOptions	of(CacheStoreMode cacheStoreMode, CacheRetrieveMode cacheRetrieveMode, Integer batchSize)
static FetchOptions	of(CacheStoreMode cacheStoreMode, CacheRetrieveMode cacheRetrieveMode, Integer batchSize, FetchMethod fetchMethod)
CacheMode	overrideCacheMode(CacheMode previousCacheMode)
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Field Details

NONE

public static final FetchOptions NONE

Constructor Details

FetchOptions

public FetchOptions(@Nullable
 CacheStoreMode cacheStoreMode,
 @Nullable
 CacheRetrieveMode cacheRetrieveMode,
 @Nullable
 Integer batchSize,
 @Nullable
 FetchMethod fetchMethod)

Creates an instance of a FetchOptions record class.

Parameters:

cacheStoreMode - the value for the cacheStoreMode record component

cacheRetrieveMode - the value for the cacheRetrieveMode record component

batchSize - the value for the batchSize record component

fetchMethod - the value for the fetchMethod record component

Method Details

of

public static FetchOptions of(@Nullable
 CacheStoreMode cacheStoreMode,
 @Nullable
 CacheRetrieveMode cacheRetrieveMode,
 @Nullable
 Integer batchSize)

of

public static FetchOptions of(@Nullable
 CacheStoreMode cacheStoreMode,
 @Nullable
 CacheRetrieveMode cacheRetrieveMode,
 @Nullable
 Integer batchSize,
 @Nullable
 FetchMethod fetchMethod)

of

public static FetchOptions of(AttributeNode<?> node)

hasOptions

public boolean hasOptions()

hasCacheModes

public boolean hasCacheModes()

hasBatchSize

public boolean hasBatchSize()

overrideCacheMode

public CacheMode overrideCacheMode(CacheMode previousCacheMode)

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. All components in this record class are compared with Objects::equals(Object,Object).

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.

cacheStoreMode

@Nullable
public CacheStoreMode cacheStoreMode()

Returns the value of the cacheStoreMode record component.

Returns:

the value of the cacheStoreMode record component

cacheRetrieveMode

@Nullable
public CacheRetrieveMode cacheRetrieveMode()

Returns the value of the cacheRetrieveMode record component.

Returns:

the value of the cacheRetrieveMode record component

batchSize

@Nullable
public Integer batchSize()

Returns the value of the batchSize record component.

Returns:

the value of the batchSize record component

fetchMethod

@Nullable
public FetchMethod fetchMethod()

Returns the value of the fetchMethod record component.

Returns:

the value of the fetchMethod record component