public interface TxnBoolean extends TxnObject
PropagationLevel.RequiresNew
).
For the other methods, always an txn needs to be available, else you will get the
TxnMandatoryException
.
All non atomic methods are able to throw a (subclass) of the ControlFlowError
. This error should
not be caught, it is task of the TxnExecutor
to deal with.
Most of the methods can throw a TxnExecutionException
.
This exception can be caught, but in most cases you want to figure out what the cause is (e.g. because
there are too many retries) and solve that problem.
All methods are threadsafe.
Modifier and Type | Method and Description |
---|---|
boolean |
alterAndGet(BooleanFunction function)
Alters the value stored in this Ref using the provided function and returns the result.
|
boolean |
alterAndGet(Txn txn,
BooleanFunction function)
Alters the value stored in this Ref using the provided function and lifting on the provided txn.
|
boolean |
atomicAlterAndGet(BooleanFunction function)
Atomically applies the function to the current value in this ref and returns the new value.
|
boolean |
atomicCompareAndSet(boolean expectedValue,
boolean newValue)
Executes a compare and set atomically.
|
boolean |
atomicGet()
Atomically gets the value.
|
boolean |
atomicGetAndAlter(BooleanFunction function)
Atomically applies the function to alter the value stored in this ref and returns the old value.
|
boolean |
atomicGetAndSet(boolean newValue)
Atomically sets the value and returns the previous value.
|
boolean |
atomicSet(boolean newValue)
Atomically sets the value and returns the new value.
|
boolean |
atomicWeakGet()
Atomically gets the value without providing any ordering guarantees.
|
void |
await(boolean value)
Awaits for the value to become the given value.
|
void |
await(BooleanPredicate predicate)
Awaits until the predicate holds.
|
void |
await(Txn txn,
boolean value)
Awaits for the reference to become the given value.
|
void |
await(Txn txn,
BooleanPredicate predicate)
Awaits until the predicate holds using the provided txn.
|
void |
commute(BooleanFunction function)
Applies the function on the ref in a commuting manner.
|
void |
commute(Txn txn,
BooleanFunction function)
Applies the function on the ref in a commuting manner.
|
boolean |
get()
Gets the value using the provided txn.
|
boolean |
get(Txn txn)
Gets the value using the provided txn.
|
boolean |
getAndAlter(BooleanFunction function)
Alters the value stored in this Ref using the provided function amd returns the old value.
|
boolean |
getAndAlter(Txn txn,
BooleanFunction function)
Alters the value stored in this Ref using the function and returns the old value, using the provided txn.
|
boolean |
getAndLock(LockMode lockMode)
Gets the value and applies the lock.
|
boolean |
getAndLock(Txn txn,
LockMode lockMode)
Gets the value using the provided txn and acquired the lock with the specified LockMode.
|
boolean |
getAndSet(boolean value)
Sets the value the value and returns the new value.
|
boolean |
getAndSet(Txn txn,
boolean value)
Sets the value using the provided txn.
|
boolean |
getAndSetAndLock(boolean value,
LockMode lockMode)
Sets the value, acquired the Lock with the specified Lockmode and returns the previous value.
|
boolean |
getAndSetAndLock(Txn txn,
boolean value,
LockMode lockMode)
Sets the value and acquired the Lock with the provided LockMode.
|
boolean |
set(boolean value)
Sets the new value.
|
boolean |
set(Txn txn,
boolean value)
Sets the new value using the provided txn.
|
boolean |
setAndLock(boolean value,
LockMode lockMode)
Sets the new value and applies the lock.
|
boolean |
setAndLock(Txn txn,
boolean value,
LockMode lockMode)
Sets the new value using the provided txn.
|
atomicToString, ensure, ensure, getLock, getStm, getVersion, toDebugString, toString, toString
boolean get()
TxnExecutionException
- if something failed while using the txn. The txn is guaranteed to have been aborted.ControlFlowError
- if the Stm needs to control the flow in a different way than normal returns of exceptions. The txn
is guaranteed to have been aborted.atomicGet()
boolean getAndLock(LockMode lockMode)
This call lifts on the Txn
stored in the TxnThreadLocal
.
lockMode
- the LockMode applied.TxnExecutionException
- if something failed while using the txn. The txn is guaranteed to have been aborted.ControlFlowError
- if the Stm needs to control the flow in a different way than normal returns of exceptions. The txn
is guaranteed to have been aborted.atomicGet()
boolean get(Txn txn)
txn
- the Txn
used for this operation.NullPointerException
- if txn is null.TxnExecutionException
- if something failed while using the txn. The txn is guaranteed to have been aborted.ControlFlowError
- if the Stm needs to control the flow in a different way than normal returns of exceptions. The txn
is guaranteed to have been aborted.boolean getAndLock(Txn txn, LockMode lockMode)
txn
- the Txn
used for this operation.lockMode
- the LockMode usedNullPointerException
- if txn is null or if lockMode is null. If LockMode is null and a running txn is available
it will be aborted.TxnExecutionException
- if something failed while using the txn. The txn is guaranteed to have been aborted.ControlFlowError
- if the Stm needs to control the flow in a different way than normal returns of exceptions. The txn
is guaranteed to have been aborted.boolean set(boolean value)
This call lifts on the Txn
stored in the TxnThreadLocal
.
value
- the new value.TxnExecutionException
- if something failed while using the txn. The txn is guaranteed to have been aborted.ControlFlowError
- if the Stm needs to control the flow in a different way than normal returns of exceptions. The txn
is guaranteed to have been aborted.boolean setAndLock(boolean value, LockMode lockMode)
This call lifts on the Txn
stored in the TxnThreadLocal
.
value
- the new value.lockMode
- the used LockMode.NullPointerException
- if lockMode is null (if the txn is alive, it will also be aborted.TxnExecutionException
- if something failed while using the txn. The txn is guaranteed to have been aborted.ControlFlowError
- if the Stm needs to control the flow in a different way than normal returns of exceptions. The txn
is guaranteed to have been aborted.boolean set(Txn txn, boolean value)
txn
- the Txn
used for this operation.value
- the new valueNullPointerException
- if txn is null.TxnExecutionException
- if something failed while using the txn. The txn is guaranteed to have been aborted.ControlFlowError
- if the Stm needs to control the flow in a different way than normal returns of exceptions. The txn
is guaranteed to have been aborted.boolean setAndLock(Txn txn, boolean value, LockMode lockMode)
txn
- the Txn
used for this operation.value
- the new valuelockMode
- the lockMode used.NullPointerException
- if txn is null or lockMode is null. If the lockMode is null and the txn
is alive, it will be aborted.TxnExecutionException
- if something failed while using the txn. The txn is guaranteed to have been aborted.ControlFlowError
- if the Stm needs to control the flow in a different way than normal returns of exceptions. The txn
is guaranteed to have been aborted.boolean getAndSet(boolean value)
This call lifts on the Txn
stored in the TxnThreadLocal
.
value
- the new value.TxnExecutionException
- if something failed while using the txn. The txn is guaranteed to have been aborted.ControlFlowError
- if the Stm needs to control the flow in a different way than normal returns of exceptions. The txn
is guaranteed to have been aborted.boolean getAndSetAndLock(boolean value, LockMode lockMode)
This call lifts on the Txn
stored in the TxnThreadLocal
.
value
- the new value.lockMode
- the LockMode used.NullPointerException
- if LockMode is null. If a running txn is available, it will be aborted.TxnExecutionException
- if something failed while using the txn. The txn is guaranteed to have been aborted.ControlFlowError
- if the Stm needs to control the flow in a different way than normal returns of exceptions. The txn
is guaranteed to have been aborted.boolean getAndSet(Txn txn, boolean value)
value
- the new value.txn
- the Txn
used for this operation.NullPointerException
- if txn is null.TxnExecutionException
- if something failed while using the txn. The txn is guaranteed to have been aborted.ControlFlowError
- if the Stm needs to control the flow in a different way than normal returns of exceptions. The txn
is guaranteed to have been aborted.boolean getAndSetAndLock(Txn txn, boolean value, LockMode lockMode)
This call lifts on the Txn
stored in the TxnThreadLocal
.
value
- the new value.txn
- the Txn
used for this operation.lockMode
- the LockMode used.NullPointerException
- if txn or LockMode is null. If the txn is running, and the LockMode is null,
it will be aborted.TxnExecutionException
- if something failed while using the txn. The txn is guaranteed to have been aborted.ControlFlowError
- if the Stm needs to control the flow in a different way than normal returns of exceptions. The txn
is guaranteed to have been aborted.boolean atomicGet()
atomicWeakGet()
.TxnExecutionException
boolean atomicWeakGet()
It is the best method to call if you just want to get the current value stored.
boolean atomicSet(boolean newValue)
newValue
- the new value.TxnExecutionException
boolean atomicGetAndSet(boolean newValue)
newValue
- the new value.TxnExecutionException
void commute(BooleanFunction function)
This is different than the behavior in Clojure where the commute will be re-applied at the end of the txn, even though some dependency is introduced, which can lead to inconsistencies.
This call lifts on the Txn
stored in the TxnThreadLocal
.
function
- the function to apply to this reference.NullPointerException
- if function is null.TxnExecutionException
- if something failed while using the txn. The txn is guaranteed to have been aborted.ControlFlowError
- if the Stm needs to control the flow in a different way than normal returns of exceptions. The txn
is guaranteed to have been aborted.void commute(Txn txn, BooleanFunction function)
This is different than the behavior in Clojure where the commute will be re-applied at the end of the txn, even though some dependency is introduced, which can lead to inconsistencies.
This call lifts on the Txn
stored in the TxnThreadLocal
.
txn
- the Txn
used for this operation.function
- the function to apply to this reference.NullPointerException
- if function is null. If there is an active txn, it will be aborted.TxnExecutionException
- if something failed while using the txn. The txn is guaranteed to have been aborted.ControlFlowError
- if the Stm needs to control the flow in a different way than normal returns of exceptions. The txn
is guaranteed to have been aborted.boolean atomicAlterAndGet(BooleanFunction function)
function
- the Function usedNullPointerException
- if function is null.boolean alterAndGet(BooleanFunction function)
This call lifts on the Txn
stored in the TxnThreadLocal
.
function
- the function that alters the value stored in this Ref.NullPointerException
- if function is null. The Txn will also be aborted.TxnExecutionException
- if something failed while using the txn. The txn is guaranteed to have been aborted.ControlFlowError
- if the Stm needs to control the flow in a different way than normal returns of exceptions. The txn
is guaranteed to have been aborted.boolean alterAndGet(Txn txn, BooleanFunction function)
function
- the function that alters the value stored in this Ref.txn
- the Txn
used for this operation.NullPointerException
- if function or txn is null.TxnExecutionException
- if something failed while using the txn. The txn is guaranteed to have been aborted.ControlFlowError
- if the Stm needs to control the flow in a different way than normal returns of exceptions. The txn
is guaranteed to have been aborted.boolean atomicGetAndAlter(BooleanFunction function)
function
- the Function usedNullPointerException
- if function is null.TxnExecutionException
boolean getAndAlter(BooleanFunction function)
This call lifts on the Txn
stored in the TxnThreadLocal
.
function
- the function that alters the value stored in this Ref.NullPointerException
- if function is null. The txn will be aborted as well.TxnExecutionException
- if something failed while using the txn. The txn is guaranteed to have been aborted.ControlFlowError
- if the Stm needs to control the flow in a different way than normal returns of exceptions. The txn
is guaranteed to have been aborted.boolean getAndAlter(Txn txn, BooleanFunction function)
function
- the function that alters the value stored in this Ref.txn
- the Txn
used for this operation.NullPointerException
- if function or txn is null. The txn will be aborted as well.TxnExecutionException
- if something failed while using the txn. The txn is guaranteed to have been aborted.ControlFlowError
- if the Stm needs to control the flow in a different way than normal returns of exceptions. The txn
is guaranteed to have been aborted.boolean atomicCompareAndSet(boolean expectedValue, boolean newValue)
expectedValue
- the expected value.newValue
- the new value.TxnExecutionException
void await(boolean value)
This call lifts on the Txn
stored in the TxnThreadLocal
.
value
- the value to wait for.TxnExecutionException
- if something failed while using the txn. The txn is guaranteed to have been aborted.ControlFlowError
- if the Stm needs to control the flow in a different way than normal returns of exceptions. The txn
is guaranteed to have been aborted.void await(Txn txn, boolean value)
txn
- the Txn
used for this operation.value
- the value to wait for.NullPointerException
- if txn is null.TxnExecutionException
- if something failed while using the txn. The txn is guaranteed to have been aborted.ControlFlowError
- if the Stm needs to control the flow in a different way than normal returns of exceptions. The txn
is guaranteed to have been aborted.void await(BooleanPredicate predicate)
This call lifts on the Txn
stored in the TxnThreadLocal
.
predicate
- the predicate to evaluate.NullPointerException
- if predicate is null. When there is a non dead txn,
it will be aborted.TxnExecutionException
- if something failed while using the txn. The txn is guaranteed to have been aborted.ControlFlowError
- if the Stm needs to control the flow in a different way than normal returns of exceptions. The txn
is guaranteed to have been aborted.void await(Txn txn, BooleanPredicate predicate)
txn
- the Txn
used for this operation.predicate
- the predicate to evaluate.NullPointerException
- if predicate is null or txn is null. When there is a non dead txn,
it will be aborted.TxnExecutionException
- if something failed while using the txn. The txn is guaranteed to have been aborted.ControlFlowError
- if the Stm needs to control the flow in a different way than normal returns of exceptions. The txn
is guaranteed to have been aborted.Copyright © 2020. All rights reserved.