java.lang.Object
- java.util.concurrent.locks.ReentrantReadWriteLock
- - com.helger.commons.concurrent.SimpleReadWriteLock

All Implemented Interfaces:

Serializable, ReadWriteLock
```
public class SimpleReadWriteLock
extends ReentrantReadWriteLock
```
This is an extension around ReentrantReadWriteLock that allows for easy usage with Java 8 :) See readLocked(Runnable) and writeLocked(Runnable) method. For throwing versions see readLockedThrowing(IThrowingRunnable) and writeLockedThrowing(IThrowingRunnable). Also methods for callables are available.

Author:

Philip Helger

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class java.util.concurrent.locks.ReentrantReadWriteLock
  ReentrantReadWriteLock.ReadLock, ReentrantReadWriteLock.WriteLock

Constructor Summary

Constructors
Constructor	Description
`SimpleReadWriteLock()`	Default constructor creating a default `ReentrantReadWriteLock`
`SimpleReadWriteLock(boolean bFair)`	Constructor creating a `ReentrantReadWriteLock` with the provided fairness

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`readLocked(Runnable aRunnable)`	Execute the provided runnable in a read lock.
`boolean`	`readLocked(BooleanSupplier aSupplier)`	Deprecated. Since 9.4.0; Use `readLockedBoolean(BooleanSupplier)` instead
`double`	`readLocked(DoubleSupplier aSupplier)`	Deprecated. Since 9.4.0; Use `readLockedDouble(DoubleSupplier)` instead
`int`	`readLocked(IntSupplier aSupplier)`	Deprecated. Since 9.4.0; Use `readLockedInt(IntSupplier)` instead
`long`	`readLocked(LongSupplier aSupplier)`	Deprecated. Since 9.4.0; Use `readLockedLong(LongSupplier)` instead
`<T> T`	`readLocked(Supplier<? extends T> aSupplier)`	Deprecated. Since 9.4.0; Use `readLockedGet(Supplier)` instead
`boolean`	`readLockedBoolean(BooleanSupplier aSupplier)`	Execute the provided callable in a read lock.
`double`	`readLockedDouble(DoubleSupplier aSupplier)`	Execute the provided callable in a read lock.
`<T> T`	`readLockedGet(Supplier<? extends T> aSupplier)`	Execute the provided callable in a read lock.
`<T,EXTYPE extends Exception> T`	`readLockedGetThrowing(IThrowingSupplier<? extends T,EXTYPE> aCallable)`	Execute the provided callable in a read lock.
`int`	`readLockedInt(IntSupplier aSupplier)`	Execute the provided callable in a read lock.
`long`	`readLockedLong(LongSupplier aSupplier)`	Execute the provided callable in a read lock.
`<EXTYPE extends Exception> void`	`readLockedThrowing(IThrowingRunnable<EXTYPE> aRunnable)`	Execute the provided runnable in a read lock.
`<T,EXTYPE extends Exception> T`	`readLockedThrowing(IThrowingSupplier<? extends T,EXTYPE> aCallable)`	Deprecated. Since 9.4.0; Use `readLockedGetThrowing(IThrowingSupplier)` instead
`void`	`writeLocked(Runnable aRunnable)`	Execute the provided runnable in a write lock.
`boolean`	`writeLocked(BooleanSupplier aSupplier)`	Deprecated. Since 9.4.0; Use `writeLockedBoolean(BooleanSupplier)` instead
`double`	`writeLocked(DoubleSupplier aSupplier)`	Deprecated. Since 9.4.0; Use `writeLockedDouble(DoubleSupplier)` instead
`int`	`writeLocked(IntSupplier aSupplier)`	Deprecated. Since 9.4.0; Use `writeLockedInt(IntSupplier)` instead
`long`	`writeLocked(LongSupplier aSupplier)`	Deprecated. Since 9.4.0; Use `writeLockedLong(LongSupplier)` instead
`<T> T`	`writeLocked(Supplier<? extends T> aSupplier)`	Deprecated. Since 9.4.0; Use `writeLockedGet(Supplier)` instead
`boolean`	`writeLockedBoolean(BooleanSupplier aSupplier)`	Execute the provided callable in a write lock.
`double`	`writeLockedDouble(DoubleSupplier aSupplier)`	Execute the provided callable in a write lock.
`<T> T`	`writeLockedGet(Supplier<? extends T> aSupplier)`	Execute the provided callable in a write lock.
`<T,EXTYPE extends Exception> T`	`writeLockedGetThrowing(IThrowingSupplier<? extends T,EXTYPE> aCallable)`	Execute the provided callable in a write lock.
`int`	`writeLockedInt(IntSupplier aSupplier)`	Execute the provided callable in a write lock.
`long`	`writeLockedLong(LongSupplier aSupplier)`	Execute the provided callable in a write lock.
`<EXTYPE extends Exception> void`	`writeLockedThrowing(IThrowingRunnable<EXTYPE> aRunnable)`	Execute the provided runnable in a write lock.
`<T,EXTYPE extends Exception> T`	`writeLockedThrowing(IThrowingSupplier<? extends T,EXTYPE> aCallable)`	Deprecated. Since 9.4.0; Use `writeLockedGetThrowing(IThrowingSupplier)` instead

Methods inherited from class java.util.concurrent.locks.ReentrantReadWriteLock
getOwner, getQueuedReaderThreads, getQueuedThreads, getQueuedWriterThreads, getQueueLength, getReadHoldCount, getReadLockCount, getWaitingThreads, getWaitQueueLength, getWriteHoldCount, hasQueuedThread, hasQueuedThreads, hasWaiters, isFair, isWriteLocked, isWriteLockedByCurrentThread, readLock, toString, writeLock

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SimpleReadWriteLock
```
public SimpleReadWriteLock()
```
    Default constructor creating a default ReentrantReadWriteLock
  - SimpleReadWriteLock
```
public SimpleReadWriteLock(boolean bFair)
```
    Constructor creating a ReentrantReadWriteLock with the provided fairness
    
    Parameters:
    
    bFair - true if this lock should use a fair ordering policy
- Method Detail
  - readLocked
```
@Deprecated
public <T> T readLocked(@Nonnull
                        Supplier<? extends T> aSupplier)
```
    Deprecated.
    Since 9.4.0; Use readLockedGet(Supplier) instead
    
    Execute the provided callable in a read lock. Note: no nullable/non-nullable can be assumed.
    
    Type Parameters:
    
    T - Return type
    
    Parameters:
    
    aSupplier - Callable to be executed. May not be null.
    
    Returns:
    
    The return value of the callable. May be null.
  - readLockedGet
```
public <T> T readLockedGet(@Nonnull
                           Supplier<? extends T> aSupplier)
```
    Execute the provided callable in a read lock. Note: no nullable/non-nullable can be assumed.
    
    Type Parameters:
    
    T - Return type
    
    Parameters:
    
    aSupplier - Callable to be executed. May not be null.
    
    Returns:
    
    The return value of the callable. May be null.
  - readLocked
```
public void readLocked(@Nonnull
                       Runnable aRunnable)
```
    Execute the provided runnable in a read lock.
    
    Parameters:
    
    aRunnable - Runnable to be executed. May not be null.
  - readLockedThrowing
```
public <EXTYPE extends Exception> void readLockedThrowing(@Nonnull
                                                          IThrowingRunnable<EXTYPE> aRunnable)
                                                   throws EXTYPE extends Exception
```
    Execute the provided runnable in a read lock.
    
    Type Parameters:
    
    EXTYPE - Exception type to be thrown
    
    Parameters:
    
    aRunnable - Runnable to be executed. May not be null.
    
    Throws:
    
    EXTYPE - If the callable throws the exception
    
    EXTYPE extends Exception
  - readLockedThrowing
```
@Deprecated
public <T,EXTYPE extends Exception> T readLockedThrowing(@Nonnull
                                                               IThrowingSupplier<? extends T,EXTYPE> aCallable)
                                                        throws EXTYPE extends Exception
```
    Deprecated.
    Since 9.4.0; Use readLockedGetThrowing(IThrowingSupplier) instead
    
    Execute the provided callable in a read lock. Note: no nullable/non-nullable can be assumed.
    
    Type Parameters:
    
    T - Return type
    
    EXTYPE - Exception type to be thrown
    
    Parameters:
    
    aCallable - Callable to be executed. May not be null.
    
    Returns:
    
    The return value of the callable. May be null.
    
    Throws:
    
    EXTYPE - If the callable throws the exception
    
    EXTYPE extends Exception
  - readLockedGetThrowing
```
public <T,EXTYPE extends Exception> T readLockedGetThrowing(@Nonnull
                                                                  IThrowingSupplier<? extends T,EXTYPE> aCallable)
                                                           throws EXTYPE extends Exception
```
    Execute the provided callable in a read lock. Note: no nullable/non-nullable can be assumed.
    
    Type Parameters:
    
    T - Return type
    
    EXTYPE - Exception type to be thrown
    
    Parameters:
    
    aCallable - Callable to be executed. May not be null.
    
    Returns:
    
    The return value of the callable. May be null.
    
    Throws:
    
    EXTYPE - If the callable throws the exception
    
    EXTYPE extends Exception
  - readLocked
```
@Deprecated
public boolean readLocked(@Nonnull
                          BooleanSupplier aSupplier)
```
    Deprecated.
    Since 9.4.0; Use readLockedBoolean(BooleanSupplier) instead
    
    Execute the provided callable in a read lock.
    
    Parameters:
    
    aSupplier - Callable to be executed. May not be null.
    
    Returns:
    
    The return value of the callable. May be null.
  - readLockedBoolean
```
public boolean readLockedBoolean(@Nonnull
                                 BooleanSupplier aSupplier)
```
    Execute the provided callable in a read lock.
    
    Parameters:
    
    aSupplier - Callable to be executed. May not be null.
    
    Returns:
    
    The return value of the callable. May be null.
  - readLocked
```
@Deprecated
public double readLocked(@Nonnull
                         DoubleSupplier aSupplier)
```
    Deprecated.
    Since 9.4.0; Use readLockedDouble(DoubleSupplier) instead
    
    Execute the provided callable in a read lock.
    
    Parameters:
    
    aSupplier - Callable to be executed. May not be null.
    
    Returns:
    
    The return value of the callable. May be null.
  - readLockedDouble
```
public double readLockedDouble(@Nonnull
                               DoubleSupplier aSupplier)
```
    Execute the provided callable in a read lock.
    
    Parameters:
    
    aSupplier - Callable to be executed. May not be null.
    
    Returns:
    
    The return value of the callable. May be null.
  - readLocked
```
@Deprecated
public int readLocked(@Nonnull
                      IntSupplier aSupplier)
```
    Deprecated.
    Since 9.4.0; Use readLockedInt(IntSupplier) instead
    
    Execute the provided callable in a read lock.
    
    Parameters:
    
    aSupplier - Callable to be executed. May not be null.
    
    Returns:
    
    The return value of the callable. May be null.
  - readLockedInt
```
public int readLockedInt(@Nonnull
                         IntSupplier aSupplier)
```
    Execute the provided callable in a read lock.
    
    Parameters:
    
    aSupplier - Callable to be executed. May not be null.
    
    Returns:
    
    The return value of the callable. May be null.
  - readLocked
```
@Deprecated
public long readLocked(@Nonnull
                       LongSupplier aSupplier)
```
    Deprecated.
    Since 9.4.0; Use readLockedLong(LongSupplier) instead
    
    Execute the provided callable in a read lock.
    
    Parameters:
    
    aSupplier - Callable to be executed. May not be null.
    
    Returns:
    
    The return value of the callable. May be null.
  - readLockedLong
```
public long readLockedLong(@Nonnull
                           LongSupplier aSupplier)
```
    Execute the provided callable in a read lock.
    
    Parameters:
    
    aSupplier - Callable to be executed. May not be null.
    
    Returns:
    
    The return value of the callable. May be null.
  - writeLocked
```
public void writeLocked(@Nonnull
                        Runnable aRunnable)
```
    Execute the provided runnable in a write lock.
    
    Parameters:
    
    aRunnable - Runnable to be executed. May not be null.
  - writeLockedThrowing
```
public <EXTYPE extends Exception> void writeLockedThrowing(@Nonnull
                                                           IThrowingRunnable<EXTYPE> aRunnable)
                                                    throws EXTYPE extends Exception
```
    Execute the provided runnable in a write lock.
    
    Type Parameters:
    
    EXTYPE - Exception type to be thrown
    
    Parameters:
    
    aRunnable - Runnable to be executed. May not be null.
    
    Throws:
    
    EXTYPE - If the runnable throws the exception
    
    EXTYPE extends Exception
  - writeLocked
```
@Deprecated
public <T> T writeLocked(@Nonnull
                         Supplier<? extends T> aSupplier)
```
    Deprecated.
    Since 9.4.0; Use writeLockedGet(Supplier) instead
    
    Execute the provided callable in a write lock. Note: no nullable/non-nullable can be assumed.
    
    Type Parameters:
    
    T - Return type
    
    Parameters:
    
    aSupplier - Callable to be executed. May not be null.
    
    Returns:
    
    The return value of the callable. May be null.
  - writeLockedGet
```
public <T> T writeLockedGet(@Nonnull
                            Supplier<? extends T> aSupplier)
```
    Execute the provided callable in a write lock. Note: no nullable/non-nullable can be assumed.
    
    Type Parameters:
    
    T - Return type
    
    Parameters:
    
    aSupplier - Callable to be executed. May not be null.
    
    Returns:
    
    The return value of the callable. May be null.
  - writeLockedThrowing
```
@Deprecated
public <T,EXTYPE extends Exception> T writeLockedThrowing(@Nonnull
                                                                IThrowingSupplier<? extends T,EXTYPE> aCallable)
                                                         throws EXTYPE extends Exception
```
    Deprecated.
    Since 9.4.0; Use writeLockedGetThrowing(IThrowingSupplier) instead
    
    Execute the provided callable in a write lock. Note: no nullable/non-nullable can be assumed.
    
    Type Parameters:
    
    T - Return type
    
    EXTYPE - Exception type to be thrown
    
    Parameters:
    
    aCallable - Callable to be executed. May not be null.
    
    Returns:
    
    The return value of the callable. May be null.
    
    Throws:
    
    EXTYPE - If the callable throws the exception
    
    EXTYPE extends Exception
  - writeLockedGetThrowing
```
public <T,EXTYPE extends Exception> T writeLockedGetThrowing(@Nonnull
                                                                   IThrowingSupplier<? extends T,EXTYPE> aCallable)
                                                            throws EXTYPE extends Exception
```
    Execute the provided callable in a write lock. Note: no nullable/non-nullable can be assumed.
    
    Type Parameters:
    
    T - Return type
    
    EXTYPE - Exception type to be thrown
    
    Parameters:
    
    aCallable - Callable to be executed. May not be null.
    
    Returns:
    
    The return value of the callable. May be null.
    
    Throws:
    
    EXTYPE - If the callable throws the exception
    
    EXTYPE extends Exception
  - writeLocked
```
@Deprecated
public boolean writeLocked(@Nonnull
                           BooleanSupplier aSupplier)
```
    Deprecated.
    Since 9.4.0; Use writeLockedBoolean(BooleanSupplier) instead
    
    Execute the provided callable in a write lock.
    
    Parameters:
    
    aSupplier - Callable to be executed. May not be null.
    
    Returns:
    
    The return value of the callable. May be null.
  - writeLockedBoolean
```
public boolean writeLockedBoolean(@Nonnull
                                  BooleanSupplier aSupplier)
```
    Execute the provided callable in a write lock.
    
    Parameters:
    
    aSupplier - Callable to be executed. May not be null.
    
    Returns:
    
    The return value of the callable. May be null.
  - writeLocked
```
@Deprecated
public double writeLocked(@Nonnull
                          DoubleSupplier aSupplier)
```
    Deprecated.
    Since 9.4.0; Use writeLockedDouble(DoubleSupplier) instead
    
    Execute the provided callable in a write lock.
    
    Parameters:
    
    aSupplier - Callable to be executed. May not be null.
    
    Returns:
    
    The return value of the callable. May be null.
  - writeLockedDouble
```
public double writeLockedDouble(@Nonnull
                                DoubleSupplier aSupplier)
```
    Execute the provided callable in a write lock.
    
    Parameters:
    
    aSupplier - Callable to be executed. May not be null.
    
    Returns:
    
    The return value of the callable. May be null.
  - writeLocked
```
@Deprecated
public int writeLocked(@Nonnull
                       IntSupplier aSupplier)
```
    Deprecated.
    Since 9.4.0; Use writeLockedInt(IntSupplier) instead
    
    Execute the provided callable in a write lock.
    
    Parameters:
    
    aSupplier - Callable to be executed. May not be null.
    
    Returns:
    
    The return value of the callable. May be null.
  - writeLockedInt
```
public int writeLockedInt(@Nonnull
                          IntSupplier aSupplier)
```
    Execute the provided callable in a write lock.
    
    Parameters:
    
    aSupplier - Callable to be executed. May not be null.
    
    Returns:
    
    The return value of the callable. May be null.
  - writeLocked
```
@Deprecated
public long writeLocked(@Nonnull
                        LongSupplier aSupplier)
```
    Deprecated.
    Since 9.4.0; Use writeLockedLong(LongSupplier) instead
    
    Execute the provided callable in a write lock.
    
    Parameters:
    
    aSupplier - Callable to be executed. May not be null.
    
    Returns:
    
    The return value of the callable. May be null.
  - writeLockedLong
```
public long writeLockedLong(@Nonnull
                            LongSupplier aSupplier)
```
    Execute the provided callable in a write lock.
    
    Parameters:
    
    aSupplier - Callable to be executed. May not be null.
    
    Returns:
    
    The return value of the callable. May be null.

Class SimpleReadWriteLock

Nested Class Summary

Nested classes/interfaces inherited from class java.util.concurrent.locks.ReentrantReadWriteLock

Constructor Summary

Method Summary

Methods inherited from class java.util.concurrent.locks.ReentrantReadWriteLock

Methods inherited from class java.lang.Object

Constructor Detail

SimpleReadWriteLock

SimpleReadWriteLock

Method Detail

readLocked

readLockedGet

readLocked

readLockedThrowing

readLockedThrowing

readLockedGetThrowing

readLocked

readLockedBoolean

readLocked

readLockedDouble

readLocked

readLockedInt

readLocked

readLockedLong

writeLocked

writeLockedThrowing

writeLocked

writeLockedGet

writeLockedThrowing

writeLockedGetThrowing

writeLocked

writeLockedBoolean

writeLocked

writeLockedDouble

writeLocked

writeLockedInt

writeLocked

writeLockedLong