com.helger.commons.concurrent

Class SimpleReadWriteLock

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 and Description
SimpleReadWriteLock() Default constructor creating a default ReentrantReadWriteLock
SimpleReadWriteLock(boolean bFair) Constructor creating a ReentrantReadWriteLock with the provided fairness

Method Summary

Modifier and Type	Method and Description
boolean	readLocked(BooleanSupplier aSupplier) Execute the provided callable in a read lock.
double	readLocked(DoubleSupplier aSupplier) Execute the provided callable in a read lock.
int	readLocked(IntSupplier aSupplier) Execute the provided callable in a read lock.
long	readLocked(LongSupplier aSupplier) Execute the provided callable in a read lock.
void	readLocked(Runnable aRunnable) Execute the provided runnable in a read lock.
<T> T	readLocked(Supplier<? extends T> 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) Execute the provided callable in a read lock.
boolean	writeLocked(BooleanSupplier aSupplier) Execute the provided callable in a write lock.
double	writeLocked(DoubleSupplier aSupplier) Execute the provided callable in a write lock.
int	writeLocked(IntSupplier aSupplier) Execute the provided callable in a write lock.
long	writeLocked(LongSupplier aSupplier) Execute the provided callable in a write lock.
void	writeLocked(Runnable aRunnable) Execute the provided runnable in a write lock.
<T> T	writeLocked(Supplier<? extends T> 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) Execute the provided callable in a write lock.

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

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

readLocked

public <T> T readLocked(@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.

readLockedThrowing

public <T,EXTYPE extends Exception> T readLockedThrowing(@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

public boolean readLocked(@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

public double readLocked(@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

public int readLocked(@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

public long readLocked(@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

public <T> T writeLocked(@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

public <T,EXTYPE extends Exception> T writeLockedThrowing(@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

public boolean writeLocked(@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

public double writeLocked(@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

public int writeLocked(@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

public long writeLocked(@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.