Hibernate ORM - hibernate-core 5.6.15.Final · org.hibernate.LockOptions

Field Summary

Modifier and Type	Field and Description
private Map<String, LockMode>	aliasSpecificLockModes
private Boolean	followOnLocking
private LockMode	lockMode
public static final int	NO_WAIT Indicates that the database should not wait at all to acquire the pessimistic lock.
public static final LockOptions	NONE Represents LockMode.NONE (timeout + scope do not apply).
public static final LockOptions	READ Represents LockMode.READ (timeout + scope do not apply).
private boolean	scope
public static final int	SKIP_LOCKED Indicates that rows that are already locked should be skipped.
private int	timeout
public static final LockOptions	UPGRADE Represents LockMode.UPGRADE (will wait forever for lock and scope of false meaning only entity is locked).
public static final int	WAIT_FOREVER Indicates that there is no timeout for the acquisition.

Constructor Summary

Access	Constructor and Description
public	LockOptions() Constructs a LockOptions with all default options.
public	LockOptions(LockMode The lock mode to use lockMode) Constructs a LockOptions with the given lock mode.

Method Summary

Modifier and Type	Method and Description
public static LockOptions	Returns: destination copy(LockOptions Source for the copy (copied from) source, LockOptions Destination for the copy (copied to) destination) Perform a shallow copy.
public LockMode	Returns: The greatest of all requested lock modes. findGreatestLockMode() Currently needed for follow-on locking.
public int	Returns: the number of explicitly defined alias lock modes. getAliasLockCount() Get the number of aliases that have specific lock modes defined.
public Iterator<Map.Entry<String, LockMode>>	Returns: Iterator for accessing the Map.Entry's getAliasLockIterator() Iterator for accessing Alias (key) and LockMode (value) as Map.Entry.
public LockMode	Returns: The explicit lock mode for that alias. getAliasSpecificLockMode(String The alias for which to locate the explicit lock mode. alias) Get the `LockMode` explicitly specified for the given alias via `setAliasSpecificLockMode` Differs from `getEffectiveLockMode` in that here we only return explicitly specified alias-specific lock modes.
public Iterable<Map.Entry<String, LockMode>>	Returns: Iterable for accessing the Map.Entry's getAliasSpecificLocks() Iterable access to alias (key) and LockMode (value) as Map.Entry.
public LockMode	Returns: The effective lock mode. getEffectiveLockMode(String The alias for which to locate the effective lock mode. alias) Determine the `LockMode` to apply to the given alias.
public Boolean	Returns: true if follow-on-locking is enabled getFollowOnLocking() Retrieve the current follow-on-locking setting.
public LockMode	Returns: The overall lock mode. getLockMode() Retrieve the overall lock mode in effect for this set of options.
public boolean	Returns: true if locking will be extended to owned associations getScope() Retrieve the current lock scope setting.
public int	Returns: timeout in milliseconds, `NO_WAIT`, `WAIT_FOREVER` or `SKIP_LOCKED` getTimeOut() Retrieve the current timeout setting.
public boolean	Returns: `true` if this LockOptions object define alias-specific lock modes; `false` otherwise. hasAliasSpecificLockModes() Does this LockOptions object define alias-specific lock modes?
public static LockOptions	interpret(LockMode lockMode)
public LockOptions	Returns: The copy makeCopy() Make a copy.
public LockOptions	Returns: this LockRequest instance for operation chaining. setAliasSpecificLockMode(String used to reference the LockMode. alias, LockMode The lock mode to apply to the given alias lockMode) Specify the `LockMode` to be used for a specific query alias.
public LockOptions	Returns: this (for method chaining). setFollowOnLocking(Boolean The new follow-on-locking setting followOnLocking) Set the the follow-on-locking setting.
public LockOptions	Returns: this (for method chaining). setLockMode(LockMode The new overall lock mode to use. lockMode) Set the overall `LockMode` to be used.
public LockOptions	Returns: this (for method chaining). setScope(boolean The new scope setting scope) Set the scope.
public LockOptions	Returns: this (for method chaining). setTimeOut(int The new timeout setting, in milliseconds timeout) Set the timeout setting.

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

Field Detail

aliasSpecificLockModes	back to summary
private Map<String, LockMode> aliasSpecificLockModes

followOnLocking	back to summary
private Boolean followOnLocking

lockMode	back to summary
private LockMode lockMode

NO_WAIT back to summary

NO_WAIT	back to summary
public static final int NO_WAIT Indicates that the database should not wait at all to acquire the pessimistic lock. See Also `getTimeOut`

public static final int NO_WAIT

Indicates that the database should not wait at all to acquire the pessimistic lock.

See Also: getTimeOut

NONE	back to summary
public static final LockOptions NONE Represents LockMode.NONE (timeout + scope do not apply).

READ	back to summary
public static final LockOptions READ Represents LockMode.READ (timeout + scope do not apply).

scope	back to summary
private boolean scope

SKIP_LOCKED back to summary

SKIP_LOCKED	back to summary
public static final int SKIP_LOCKED Indicates that rows that are already locked should be skipped. See Also `getTimeOut()`

public static final int SKIP_LOCKED

Indicates that rows that are already locked should be skipped.

See Also: getTimeOut()

timeout	back to summary
private int timeout

UPGRADE	back to summary
public static final LockOptions UPGRADE Represents LockMode.UPGRADE (will wait forever for lock and scope of false meaning only entity is locked). Annotations @SuppressWarnings:deprecation

WAIT_FOREVER back to summary

WAIT_FOREVER	back to summary
public static final int WAIT_FOREVER Indicates that there is no timeout for the acquisition. See Also `getTimeOut`

public static final int WAIT_FOREVER

Indicates that there is no timeout for the acquisition.

See Also: getTimeOut

Constructor Detail

LockOptions	back to summary
public LockOptions() Constructs a LockOptions with all default options.

LockOptions	back to summary
public LockOptions(LockMode lockMode) Constructs a LockOptions with the given lock mode. Parameters lockMode:LockMode The lock mode to use

LockOptions

back to summary

public LockOptions(LockMode lockMode)

Constructs a LockOptions with the given lock mode.

Parameters

lockMode:LockMode: The lock mode to use

Method Detail

copy	back to summary
public static LockOptions copy(LockOptions source, LockOptions destination) Perform a shallow copy. Parameters source:LockOptions Source for the copy (copied from) destination:LockOptions Destination for the copy (copied to) Returns:LockOptions destination

copy

back to summary

public static LockOptions copy(LockOptions source, LockOptions destination)

Perform a shallow copy.

Parameters

source:LockOptions: Source for the copy (copied from)
destination:LockOptions: Destination for the copy (copied to)

Returns:LockOptions

destination

findGreatestLockMode	back to summary
public LockMode findGreatestLockMode() Currently needed for follow-on locking. Returns:LockMode The greatest of all requested lock modes.

findGreatestLockMode

back to summary

public LockMode findGreatestLockMode()

Currently needed for follow-on locking.

Returns:LockMode: The greatest of all requested lock modes.

getAliasLockCount	back to summary
public int getAliasLockCount() Get the number of aliases that have specific lock modes defined. Returns:int the number of explicitly defined alias lock modes.

getAliasLockCount

back to summary

public int getAliasLockCount()

Get the number of aliases that have specific lock modes defined.

Returns:int: the number of explicitly defined alias lock modes.

getAliasLockIterator	back to summary
public Iterator<Map.Entry<String, LockMode>> getAliasLockIterator() Iterator for accessing Alias (key) and LockMode (value) as Map.Entry. Returns:Iterator<Map.Entry<String, LockMode>> Iterator for accessing the Map.Entry's

getAliasLockIterator

back to summary

public Iterator<Map.Entry<String, LockMode>> getAliasLockIterator()

Iterator for accessing Alias (key) and LockMode (value) as Map.Entry.

Returns:Iterator<Map.Entry<String, LockMode>>: Iterator for accessing the Map.Entry's

getAliasSpecificLockMode back to summary

getAliasSpecificLockMode	back to summary
public LockMode getAliasSpecificLockMode(String alias) Get the `LockMode` explicitly specified for the given alias via `setAliasSpecificLockMode` Differs from `getEffectiveLockMode` in that here we only return explicitly specified alias-specific lock modes. Parameters alias:String The alias for which to locate the explicit lock mode. Returns:LockMode The explicit lock mode for that alias.

public LockMode getAliasSpecificLockMode(String alias)

Get the LockMode explicitly specified for the given alias via setAliasSpecificLockMode

Differs from getEffectiveLockMode in that here we only return explicitly specified alias-specific lock modes.

Parameters

alias:String: The alias for which to locate the explicit lock mode.

Returns:LockMode

The explicit lock mode for that alias.

getAliasSpecificLocks	back to summary
public Iterable<Map.Entry<String, LockMode>> getAliasSpecificLocks() Iterable access to alias (key) and LockMode (value) as Map.Entry. Returns:Iterable<Map.Entry<String, LockMode>> Iterable for accessing the Map.Entry's

getAliasSpecificLocks

back to summary

public Iterable<Map.Entry<String, LockMode>> getAliasSpecificLocks()

Iterable access to alias (key) and LockMode (value) as Map.Entry.

Returns:Iterable<Map.Entry<String, LockMode>>: Iterable for accessing the Map.Entry's

getEffectiveLockMode back to summary

getEffectiveLockMode	back to summary
public LockMode getEffectiveLockMode(String alias) Determine the `LockMode` to apply to the given alias. If no mode was explicitly `set`, the `overall mode` is returned. If the overall lock mode is `null` as well, `LockMode#NONE` is returned. Differs from `getAliasSpecificLockMode` in that here we fallback to we only return the overall lock mode. Parameters alias:String The alias for which to locate the effective lock mode. Returns:LockMode The effective lock mode.

public LockMode getEffectiveLockMode(String alias)

Determine the LockMode to apply to the given alias. If no mode was explicitly set, the overall mode is returned. If the overall lock mode is null as well, LockMode#NONE is returned.

Differs from getAliasSpecificLockMode in that here we fallback to we only return the overall lock mode.

Parameters

alias:String: The alias for which to locate the effective lock mode.

Returns:LockMode

The effective lock mode.

getFollowOnLocking	back to summary
public Boolean getFollowOnLocking() Retrieve the current follow-on-locking setting. Returns:Boolean true if follow-on-locking is enabled

getFollowOnLocking

back to summary

public Boolean getFollowOnLocking()

Retrieve the current follow-on-locking setting.

Returns:Boolean: true if follow-on-locking is enabled

getLockMode back to summary

getLockMode	back to summary
public LockMode getLockMode() Retrieve the overall lock mode in effect for this set of options. In certain contexts (hql and criteria), lock-modes can be defined in an even more granular `per-alias` fashion Returns:LockMode The overall lock mode.

public LockMode getLockMode()

Retrieve the overall lock mode in effect for this set of options.

In certain contexts (hql and criteria), lock-modes can be defined in an even more granular per-alias fashion

Returns:LockMode: The overall lock mode.

getScope	back to summary
public boolean getScope() Retrieve the current lock scope setting. "scope" is a JPA defined term. It is basically a cascading of the lock to associations. Returns:boolean true if locking will be extended to owned associations

getScope

back to summary

public boolean getScope()

Retrieve the current lock scope setting.

"scope" is a JPA defined term. It is basically a cascading of the lock to associations.

Returns:boolean: true if locking will be extended to owned associations

getTimeOut back to summary

getTimeOut	back to summary
public int getTimeOut() Retrieve the current timeout setting. The timeout is the amount of time, in milliseconds, we should instruct the database to wait for any requested pessimistic lock acquisition. `NO_WAIT`, `WAIT_FOREVER` or `SKIP_LOCKED` represent 3 "magic" values. Returns:int timeout in milliseconds, `NO_WAIT`, `WAIT_FOREVER` or `SKIP_LOCKED`

public int getTimeOut()

Retrieve the current timeout setting.

The timeout is the amount of time, in milliseconds, we should instruct the database to wait for any requested pessimistic lock acquisition.

NO_WAIT, WAIT_FOREVER or SKIP_LOCKED represent 3 "magic" values.

Returns:int: timeout in milliseconds, NO_WAIT, WAIT_FOREVER or SKIP_LOCKED

hasAliasSpecificLockModes back to summary

hasAliasSpecificLockModes	back to summary
public boolean hasAliasSpecificLockModes() Does this LockOptions object define alias-specific lock modes? Returns:boolean `true` if this LockOptions object define alias-specific lock modes; `false` otherwise.

public boolean hasAliasSpecificLockModes()

Does this LockOptions object define alias-specific lock modes?

Returns:boolean: true if this LockOptions object define alias-specific lock modes; false otherwise.

interpret	back to summary
public static LockOptions interpret(LockMode lockMode)

makeCopy	back to summary
public LockOptions makeCopy() Make a copy. Returns:LockOptions The copy

makeCopy

back to summary

public LockOptions makeCopy()

Make a copy.

Returns:LockOptions: The copy

setAliasSpecificLockMode back to summary

setAliasSpecificLockMode	back to summary
public LockOptions setAliasSpecificLockMode(String alias, LockMode lockMode) Specify the `LockMode` to be used for a specific query alias. Parameters alias:String used to reference the LockMode. lockMode:LockMode The lock mode to apply to the given alias Returns:LockOptions this LockRequest instance for operation chaining. See Also `Query#setLockMode(String, LockMode)`, `Criteria#setLockMode(LockMode)`, `Criteria#setLockMode(String, LockMode)`

public LockOptions setAliasSpecificLockMode(String alias, LockMode lockMode)

Specify the LockMode to be used for a specific query alias.

Parameters

alias:String: used to reference the LockMode.
lockMode:LockMode: The lock mode to apply to the given alias

Returns:LockOptions

this LockRequest instance for operation chaining.

setFollowOnLocking	back to summary
public LockOptions setFollowOnLocking(Boolean followOnLocking) Set the the follow-on-locking setting. Parameters followOnLocking:Boolean The new follow-on-locking setting Returns:LockOptions this (for method chaining).

setFollowOnLocking

back to summary

public LockOptions setFollowOnLocking(Boolean followOnLocking)

Set the the follow-on-locking setting.

Parameters

followOnLocking:Boolean: The new follow-on-locking setting

Returns:LockOptions

this (for method chaining).

setLockMode back to summary

setLockMode	back to summary
public LockOptions setLockMode(LockMode lockMode) Set the overall `LockMode` to be used. The default is `LockMode#NONE` Parameters lockMode:LockMode The new overall lock mode to use. Returns:LockOptions this (for method chaining).

public LockOptions setLockMode(LockMode lockMode)

Set the overall LockMode to be used. The default is LockMode#NONE

Parameters

lockMode:LockMode: The new overall lock mode to use.

Returns:LockOptions

this (for method chaining).

setScope	back to summary
public LockOptions setScope(boolean scope) Set the scope. Parameters scope:boolean The new scope setting Returns:LockOptions this (for method chaining).

setScope

back to summary

public LockOptions setScope(boolean scope)

Set the scope.

Parameters

scope:boolean: The new scope setting

Returns:LockOptions

this (for method chaining).

setTimeOut back to summary

setTimeOut	back to summary
public LockOptions setTimeOut(int timeout) Set the timeout setting. See `getTimeOut` for a discussion of meaning. Parameters timeout:int The new timeout setting, in milliseconds Returns:LockOptions this (for method chaining). See Also `getTimeOut`

public LockOptions setTimeOut(int timeout)

Set the timeout setting.

See getTimeOut for a discussion of meaning.

Parameters

timeout:int: The new timeout setting, in milliseconds

Returns:LockOptions

this (for method chaining).

See Also

getTimeOut

public Class LockOptions

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail