com.helger.commons.concurrent

Class SimpleLock

java.lang.Object

java.util.concurrent.locks.ReentrantLock

com.helger.commons.concurrent.SimpleLock

All Implemented Interfaces:

Serializable, Lock

public class SimpleLock
extends ReentrantLock

This is an extension around ReentrantLock that allows for easy usage with Java 8 :) See locked(Runnable) and locked(Runnable) method. Also methods for suppliers are available.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SimpleLock() Default constructor creating a default ReentrantLock
SimpleLock(boolean bFair) Constructor creating a ReentrantLock with the provided fairness

Method Summary

Modifier and Type	Method and Description
boolean	locked(BooleanSupplier aSupplier) Execute the provided callable in a read lock.
double	locked(DoubleSupplier aSupplier) Execute the provided callable in a read lock.
int	locked(IntSupplier aSupplier) Execute the provided callable in a read lock.
long	locked(LongSupplier aSupplier) Execute the provided callable in a read lock.
void	locked(Runnable aRunnable) Execute the provided runnable in a read lock.
<T> T	locked(Supplier<? extends T> aSupplier) Execute the provided callable in a read lock.
<EXTYPE extends Exception> void	lockedThrowing(IThrowingRunnable<EXTYPE> aRunnable) Execute the provided runnable in a read lock.
<T,EXTYPE extends Exception> T	lockedThrowing(IThrowingSupplier<? extends T,EXTYPE> aCallable) Execute the provided callable in a read lock.

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

getHoldCount, getOwner, getQueuedThreads, getQueueLength, getWaitingThreads, getWaitQueueLength, hasQueuedThread, hasQueuedThreads, hasWaiters, isFair, isHeldByCurrentThread, isLocked, lock, lockInterruptibly, newCondition, toString, tryLock, tryLock, unlock

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleLock

public SimpleLock()

Default constructor creating a default ReentrantLock

SimpleLock

public SimpleLock(boolean bFair)

Constructor creating a ReentrantLock with the provided fairness

Parameters:

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

Method Detail

locked

public void locked(@Nonnull
                   Runnable aRunnable)

Execute the provided runnable in a read lock.

Parameters:

aRunnable - Runnable to be executed. May not be null.

lockedThrowing

public <EXTYPE extends Exception> void lockedThrowing(@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

locked

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

lockedThrowing

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

locked

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

locked

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

locked

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

locked

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