Class LockingVisitors.LockVisitor<O,L>

java.lang.Object

org.apache.commons.lang3.concurrent.locks.LockingVisitors.LockVisitor<O,L>

Type Parameters:

O - The wrapped object type.

L - The wrapped lock type.

Direct Known Subclasses:

LockingVisitors.ReadWriteLockVisitor, LockingVisitors.ReentrantLockVisitor, LockingVisitors.StampedLockVisitor

Enclosing class:

LockingVisitors

public static class LockingVisitors.LockVisitor<O,L>
extends Object

Wraps a domain object and a lock for access by lambdas.

Since:

3.11

See Also:

• LockingVisitors

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LockingVisitors.LockVisitor.LVBuilder<O, L, B extends LockingVisitors.LockVisitor.LVBuilder<O,L,B>>	Builds LockingVisitors.LockVisitor instances.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LockVisitor(O object, L lock, Supplier<Lock> readLockSupplier, Supplier<Lock> writeLockSupplier)	Constructs an instance.

Method Summary

Modifier and Type	Method	Description
void	acceptReadLocked(FailableConsumer<O,?> consumer)	Invokes the consumer while holding the lock supplied for read operations.
void	acceptWriteLocked(FailableConsumer<O,?> consumer)	Invokes the consumer while holding the lock supplied for write operations.
<T> T	applyReadLocked(FailableFunction<O,T,?> function)	Applies the function while holding the lock supplied for read operations.
<T> T	applyWriteLocked(FailableFunction<O,T,?> function)	Applies the function while holding the lock supplied for write operations.
L	getLock()	Gets the lock.
O	getObject()	Gets the guarded object.
protected void	lockAcceptUnlock(Supplier<Lock> lockSupplier, FailableConsumer<O,?> consumer)	Implements acceptReadLocked(FailableConsumer) and acceptWriteLocked(FailableConsumer).
protected <T> T	lockApplyUnlock(Supplier<Lock> lockSupplier, FailableFunction<O,T,?> function)	Implements applyReadLocked(FailableFunction) and applyWriteLocked(FailableFunction).

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

LockVisitor

protected LockVisitor(O object,
 L lock,
 Supplier<Lock> readLockSupplier,
 Supplier<Lock> writeLockSupplier)

Constructs an instance.

Parameters:

object - The object to guard.

lock - The locking object.

readLockSupplier - Supplies the lock used by read methods.

writeLockSupplier - Supplies the lock used by write methods.

Method Details

acceptReadLocked

public void acceptReadLocked(FailableConsumer<O,?> consumer)

Invokes the consumer while holding the lock supplied for read operations. The lock is released in a finally block after the consumer returns or throws. Whether other readers can proceed concurrently depends on the supplied lock.

Parameters:

consumer - The consumer of the guarded object.

See Also:

• acceptWriteLocked(FailableConsumer)
• applyReadLocked(FailableFunction)

acceptWriteLocked

public void acceptWriteLocked(FailableConsumer<O,?> consumer)

Invokes the consumer while holding the lock supplied for write operations. The lock is released in a finally block after the consumer returns or throws.

Parameters:

consumer - The consumer of the guarded object.

See Also:

• acceptReadLocked(FailableConsumer)
• applyWriteLocked(FailableFunction)

applyReadLocked

public <T> T applyReadLocked(FailableFunction<O,T,?> function)

Applies the function while holding the lock supplied for read operations. The lock is released in a finally block after the function returns or throws. Whether other readers can proceed concurrently depends on the supplied lock.

Type Parameters:

T - The result type.

Parameters:

function - The function applied to the guarded object.

Returns:

The function result.

Throws:

NullPointerException - Thrown if the lock supplier is null or returns null.

See Also:

• acceptReadLocked(FailableConsumer)
• applyWriteLocked(FailableFunction)

applyWriteLocked

public <T> T applyWriteLocked(FailableFunction<O,T,?> function)

Applies the function while holding the lock supplied for write operations. The lock is released in a finally block after the function returns or throws.

Type Parameters:

T - The result type.

Parameters:

function - The function applied to the guarded object.

Returns:

The function result.

Throws:

NullPointerException - Thrown if the lock supplier is null or returns null.

See Also:

• acceptWriteLocked(FailableConsumer)
• applyReadLocked(FailableFunction)

getLock

public L getLock()

Gets the lock.

Returns:

The lock.

getObject

public O getObject()

Gets the guarded object.

Returns:

The object.

lockAcceptUnlock

protected void lockAcceptUnlock(Supplier<Lock> lockSupplier,
 FailableConsumer<O,?> consumer)

Implements acceptReadLocked(FailableConsumer) and acceptWriteLocked(FailableConsumer).

Parameters:

lockSupplier - Supplies the Lock to acquire and release, including a StampedLock view.

consumer - The consumer of the guarded object.

See Also:

• acceptReadLocked(FailableConsumer)
• acceptWriteLocked(FailableConsumer)

lockApplyUnlock

protected <T> T lockApplyUnlock(Supplier<Lock> lockSupplier,
 FailableFunction<O,T,?> function)

Implements applyReadLocked(FailableFunction) and applyWriteLocked(FailableFunction).

Type Parameters:

T - The result type.

Parameters:

lockSupplier - Supplies the Lock to acquire and release, including a StampedLock view.

function - The function applied to the guarded object.

Returns:

The function result.

Throws:

NullPointerException - Thrown if the lock supplier is null or returns null.

See Also:

• applyReadLocked(FailableFunction)
• applyWriteLocked(FailableFunction)