Package org.apache.commons.lang3.concurrent.locks

Class LockingVisitors.StampedLockVisitor<O>

java.lang.Object

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

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

Type Parameters:

O - The locked (hidden) objects type.

Enclosing class:

LockingVisitors

public static class LockingVisitors.StampedLockVisitor<O>
extends LockingVisitors.LockVisitor<O,java.util.concurrent.locks.StampedLock>

This class implements a wrapper for a locked (hidden) object, and provides the means to access it. The basic idea is that the user code forsakes all references to the locked object, using only the wrapper object, and the accessor methods LockingVisitors.LockVisitor.acceptReadLocked(FailableConsumer), LockingVisitors.LockVisitor.acceptWriteLocked(FailableConsumer), LockingVisitors.LockVisitor.applyReadLocked(FailableFunction), and LockingVisitors.LockVisitor.applyWriteLocked(FailableFunction). By doing so, the necessary protections are guaranteed.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StampedLockVisitor(O object, java.util.concurrent.locks.StampedLock stampedLock)	Creates a new instance with the given locked object.

Method Summary

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

acceptReadLocked, acceptWriteLocked, applyReadLocked, applyWriteLocked, getLock, getObject, lockAcceptUnlock, lockApplyUnlock

Methods inherited from class java.lang.Object

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

Constructor Detail

StampedLockVisitor

protected StampedLockVisitor(O object,
                             java.util.concurrent.locks.StampedLock stampedLock)

Creates a new instance with the given locked object. This constructor is supposed to be used for subclassing only. In general, it is suggested to use LockingVisitors.stampedLockVisitor(Object) instead.

Parameters:

object - The locked (hidden) object. The caller is supposed to drop all references to the locked object.

stampedLock - the lock to use.