org.apache.commons.lang3.concurrent.locks

Class LockingVisitors.ReentrantLockVisitor<O>

java.lang.Object

org.apache.commons.lang3.concurrent.locks.LockingVisitors.LockVisitor<O,java.util.concurrent.locks.ReentrantLock>

org.apache.commons.lang3.concurrent.locks.LockingVisitors.ReentrantLockVisitor<O>

Type Parameters:

O - The type of the object to protect.

Enclosing class:

LockingVisitors

public static class LockingVisitors.ReentrantLockVisitor<O>
extends LockingVisitors.LockVisitor<O,java.util.concurrent.locks.ReentrantLock>

Wraps a ReentrantLock and object to protect. To access the object, use the methods LockingVisitors.LockVisitor.acceptReadLocked(FailableConsumer), LockingVisitors.LockVisitor.acceptWriteLocked(FailableConsumer), LockingVisitors.LockVisitor.applyReadLocked(FailableFunction), and LockingVisitors.LockVisitor.applyWriteLocked(FailableFunction). The visitor holds the lock while the consumer or function is called.

Since:

3.18.0

See Also:

LockingVisitors.reentrantLockVisitor(Object)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LockingVisitors.ReentrantLockVisitor.Builder<O> Builds LockingVisitors.LockVisitor instances.

Nested classes/interfaces inherited from class org.apache.commons.lang3.concurrent.locks.LockingVisitors.LockVisitor

LockingVisitors.LockVisitor.LVBuilder<O,L,B extends LockingVisitors.LockVisitor.LVBuilder<O,L,B>>

Method Summary

Modifier and Type	Method and Description
static <O> LockingVisitors.ReentrantLockVisitor.Builder<O>	builder() Creates a new builder.

Methods inherited from class org.apache.commons.lang3.concurrent.locks.LockingVisitors.LockVisitor

acceptReadLocked, acceptWriteLocked, applyReadLocked, applyWriteLocked, getLock, getObject

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static <O> LockingVisitors.ReentrantLockVisitor.Builder<O> builder()

Creates a new builder.

Type Parameters:

O - the wrapped object type.

Returns:

a new builder.

Since:

3.18.0