Package com.inductiveautomation.ignition.common.util

Class CloseableReentrantReadWriteLock

java.lang.Object

com.inductiveautomation.ignition.common.util.CloseableReentrantReadWriteLock

public class CloseableReentrantReadWriteLock
extends Object

A wrapper around ReentrantReadWriteLock that provides auto-closeable lock acquisition for use with try-with-resources.

Example usage:

 private final CloseableLock lock = new CloseableLock(false);

 public void doSomethingUnderReadLock() {
     try (var ignored = lock.acquireReadLock()) {
         // ... code that runs while holding the read lock ...
     }
 }

 public void doSomethingUnderWriteLock() {
     try (var ignored = lock.acquireWriteLock()) {
         // ... code that runs while holding the write lock ...
     }
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CloseableReentrantReadWriteLock.CloseableLock	An AutoCloseable that releases a lock when closed.

Constructor Summary

Constructors

Constructor	Description
CloseableReentrantReadWriteLock(boolean fair)	Creates a new CloseableLock with the specified fairness policy.

Method Summary

Modifier and Type	Method	Description
static CloseableReentrantReadWriteLock.CloseableLock	acquire(Lock lock)	Acquires the given lock and returns an CloseableReentrantReadWriteLock.CloseableLock that will release it when closed.
CloseableReentrantReadWriteLock.CloseableLock	acquireReadLock()	Acquires the read lock and returns an CloseableReentrantReadWriteLock.CloseableLock that will release it when closed.
CloseableReentrantReadWriteLock.CloseableLock	acquireWriteLock()	Acquires the write lock and returns an CloseableReentrantReadWriteLock.CloseableLock that will release it when closed.

Methods inherited from class java.lang.Object

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

Constructor Details

CloseableReentrantReadWriteLock

public CloseableReentrantReadWriteLock(boolean fair)

Creates a new CloseableLock with the specified fairness policy.

Parameters:

fair - true if this lock should use a fair ordering policy

Method Details

acquireReadLock

public CloseableReentrantReadWriteLock.CloseableLock acquireReadLock()

Acquires the read lock and returns an CloseableReentrantReadWriteLock.CloseableLock that will release it when closed.

Returns:

An Unlock that releases the read lock when closed

acquireWriteLock

public CloseableReentrantReadWriteLock.CloseableLock acquireWriteLock()

Acquires the write lock and returns an CloseableReentrantReadWriteLock.CloseableLock that will release it when closed.

Returns:

An Unlock that releases the write lock when closed

acquire

public static CloseableReentrantReadWriteLock.CloseableLock acquire(Lock lock)

Acquires the given lock and returns an CloseableReentrantReadWriteLock.CloseableLock that will release it when closed. This static method is useful for wrapping arbitrary Lock instances.

Example usage:

 Lock someLock = ...;
 try (var ignored = CloseableLock.acquire(someLock)) {
     // ... code that runs while holding the lock ...
 }
 

Parameters:

lock - The lock to acquire

Returns:

An Unlock that releases the lock when closed