RefreshLockArguments (GORM for Hibernate 7

org.grails.datastore.gorm.internal.RefreshLockArguments

```
@groovy.transform.CompileStatic
class RefreshLockArguments
extends java.lang.Object
```
Resolves the named arguments shared by refresh(Map) and lock(Map, Serializable).
Since:
8.1

Properties Summary

Properties
Type	Name and description
`static java.lang.String`	`LOCK` The `refresh(Map)` argument that requests a lock: `true` for a pessimistic write lock, or a jakarta.persistence.LockModeType naming the lock to acquire.
`static java.lang.String`	`REFRESH` The `lock(Map, Serializable)` argument that requests a reload of the instance's state and version under the lock.
`static java.lang.String`	`TRANSACTION_REQUIRED` The message reported when a lock or a locked refresh is requested outside of an active transaction.
`static java.lang.String`	`TYPE` The `lock(Map, Serializable)` argument that selects the jakarta.persistence.LockModeType to acquire; defaults to jakarta.persistence.LockModeType#PESSIMISTIC_WRITE.
`static java.lang.String`	`UNSUPPORTED` The message reported when a datastore does not support refreshing an instance under a lock.
`static java.lang.String`	`UNSUPPORTED_TYPE` The message reported when a datastore does not support lock modes other than a pessimistic write lock.

Constructor Summary

Constructors
Constructor and description
`RefreshLockArguments()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static jakarta.persistence.LockModeType`	`lockModeFrom(java.util.Map args)` Resolves the lock requested by the `lock` argument.
	`static jakarta.persistence.LockModeType`	`lockTypeFrom(java.util.Map args)` Resolves the lock mode selected by the `type` argument of `lock(Map, Serializable)`.
	`static boolean`	`pessimistic(jakarta.persistence.LockModeType lockMode)` Returns: whether the lock mode takes a database lock, as opposed to the optimistic modes that only verify or increment the version when the transaction completes
	`static boolean`	`refreshRequested(java.util.Map args)` Parameters: `args` - The named arguments, may be `null`
	`static boolean`	`typeRequested(java.util.Map args)` Parameters: `args` - The named arguments, may be `null`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#equals(java.lang.Object), java.lang.Object#getClass(), java.lang.Object#hashCode(), java.lang.Object#notify(), java.lang.Object#notifyAll(), java.lang.Object#toString(), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int)`

- Property Detail
  - static final java.lang.String LOCK
    
    The refresh(Map) argument that requests a lock: true for a pessimistic write lock, or a jakarta.persistence.LockModeType naming the lock to acquire.
  - static final java.lang.String REFRESH
    
    The lock(Map, Serializable) argument that requests a reload of the instance's state and version under the lock.
  - static final java.lang.String TRANSACTION_REQUIRED
    
    The message reported when a lock or a locked refresh is requested outside of an active transaction.
  - static final java.lang.String TYPE
    
    The lock(Map, Serializable) argument that selects the jakarta.persistence.LockModeType to acquire; defaults to jakarta.persistence.LockModeType#PESSIMISTIC_WRITE.
  - static final java.lang.String UNSUPPORTED
    
    The message reported when a datastore does not support refreshing an instance under a lock.
  - static final java.lang.String UNSUPPORTED_TYPE
    
    The message reported when a datastore does not support lock modes other than a pessimistic write lock.
- Constructor Detail
  - RefreshLockArguments()
- Method Detail
  - static jakarta.persistence.LockModeType lockModeFrom(java.util.Map args)
    
    Resolves the lock requested by the lock argument.
    throws:
    IllegalArgumentException if the argument is neither a boolean, a jakarta.persistence.LockModeType, nor the name of one
    
    Parameters:
    args - The named arguments, may be null
    Returns:
    The requested lock mode, or null when no lock was requested
  - static jakarta.persistence.LockModeType lockTypeFrom(java.util.Map args)
    
    Resolves the lock mode selected by the type argument of lock(Map, Serializable).
    throws:
    IllegalArgumentException if the argument is neither a jakarta.persistence.LockModeType nor the name of one, or is jakarta.persistence.LockModeType#NONE
    
    Parameters:
    args - The named arguments, may be null
    Returns:
    The selected lock mode, jakarta.persistence.LockModeType#PESSIMISTIC_WRITE when the argument is absent
  - static boolean pessimistic(jakarta.persistence.LockModeType lockMode)
    
    Returns:
    whether the lock mode takes a database lock, as opposed to the optimistic modes that only verify or increment the version when the transaction completes
  - static boolean refreshRequested(java.util.Map args)
    
    throws:
    IllegalArgumentException if the argument is neither a boolean nor the text of one
    
    Parameters:
    args - The named arguments, may be null
    Returns:
    Whether the refresh argument requests a reload under the lock
  - static boolean typeRequested(java.util.Map args)
    
    Parameters:
    args - The named arguments, may be null
    Returns:
    Whether the call selected a lock mode itself, rather than taking the default. A type supplied as null counts as absent, the way lockTypeFrom(Map) reads it.

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

[Groovy] Class RefreshLockArguments

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

static final java.lang.String LOCK

static final java.lang.String REFRESH

static final java.lang.String TRANSACTION_REQUIRED

static final java.lang.String TYPE

static final java.lang.String UNSUPPORTED

static final java.lang.String UNSUPPORTED_TYPE

Constructor Detail

RefreshLockArguments()

Method Detail

static jakarta.persistence.LockModeType lockModeFrom(java.util.Map args)

static jakarta.persistence.LockModeType lockTypeFrom(java.util.Map args)

static boolean pessimistic(jakarta.persistence.LockModeType lockMode)

static boolean refreshRequested(java.util.Map args)

static boolean typeRequested(java.util.Map args)