com.helger.commons.concurrent

Class SimpleReadWriteLock

java.lang.Object

com.helger.commons.concurrent.SimpleReadWriteLock

All Implemented Interfaces:

Serializable, ReadWriteLock

public class SimpleReadWriteLock
extends Object
implements ReadWriteLock, Serializable

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

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
Lock	readLock()
<T> T	readLocked(INonThrowingCallable<T> aCallable) Execute the provided callable in a read lock.
void	readLocked(Runnable aRunnable) Execute the provided runnable in a read lock.
<T,EXTYPE extends Exception> T	readLockedThrowing(IThrowingCallable<T,EXTYPE> aCallable) Execute the provided callable in a read lock.
<EXTYPE extends Exception> void	readLockedThrowing(IThrowingRunnable<EXTYPE> aRunnable) Execute the provided runnable in a read lock.
Lock	writeLock()
<T> T	writeLocked(INonThrowingCallable<T> aCallable) Execute the provided callable in a write lock.
void	writeLocked(Runnable aRunnable) Execute the provided runnable in a write lock.
<T,EXTYPE extends Exception> T	writeLockedThrowing(IThrowingCallable<T,EXTYPE> aCallable) Execute the provided callable in a write lock.
<EXTYPE extends Exception> void	writeLockedThrowing(IThrowingRunnable<EXTYPE> aRunnable) Execute the provided runnable in a write lock.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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

readLock

@Nonnull
public Lock readLock()

Specified by:

readLock in interface ReadWriteLock

writeLock

@Nonnull
public Lock writeLock()

Specified by:

writeLock in interface ReadWriteLock

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

@Nullable
public <T> T readLocked(@Nonnull
                                   INonThrowingCallable<T> aCallable)

Execute the provided callable in a read lock.

Type Parameters:

T - Return type

Parameters:

aCallable - Callable to be executed. May not be null.

Returns:

The return value of the callable. May be null.

readLockedThrowing

@Nullable
public <T,EXTYPE extends Exception> T readLockedThrowing(@Nonnull
                                                                    IThrowingCallable<T,EXTYPE> aCallable)
                                                             throws EXTYPE extends Exception

Execute the provided callable in a read lock.

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 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

@Nullable
public <T> T writeLocked(@Nonnull
                                    INonThrowingCallable<T> aCallable)

Execute the provided callable in a write lock.

Type Parameters:

T - Return type

Parameters:

aCallable - Callable to be executed. May not be null.

Returns:

The return value of the callable. May be null.

writeLockedThrowing

@Nullable
public <T,EXTYPE extends Exception> T writeLockedThrowing(@Nonnull
                                                                     IThrowingCallable<T,EXTYPE> aCallable)
                                                              throws EXTYPE extends Exception

Execute the provided callable in a write lock.

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