eu.fthevenet.util.concurrent

Class ReadWriteLockHelper

java.lang.Object

eu.fthevenet.util.concurrent.ReadWriteLockHelper

public class ReadWriteLockHelper
extends java.lang.Object

An helper class that wraps a ReadWriteLock instance and provides methods to streamline usage and avoid common inattention mistakes, such as locking one the lock and unlocking the other in the finally block.

Author:

Frederic Thevenet

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReadWriteLockHelper.LockHelper An helper providing methods to run lambdas within the context of supplied lock.

Constructor Summary

Constructors

Constructor and Description
ReadWriteLockHelper() Creates a new instance of the ReadWriteLockHelper class that wraps a new instance of ReentrantReadWriteLock
ReadWriteLockHelper(java.util.concurrent.locks.ReadWriteLock lock) Creates a new instance of the ReadWriteLockHelper class for the provided lock.

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.locks.ReadWriteLock	getLock() Gets the underlying ReadWriteLock instance.
ReadWriteLockHelper.LockHelper	read() Returns an helper providing methods to run lambdas within the context of the read lock.
ReadWriteLockHelper.LockHelper	write() Returns an helper providing methods to run lambdas within the context of the write lock.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReadWriteLockHelper

public ReadWriteLockHelper()

Creates a new instance of the ReadWriteLockHelper class that wraps a new instance of ReentrantReadWriteLock

ReadWriteLockHelper

public ReadWriteLockHelper(java.util.concurrent.locks.ReadWriteLock lock)

Creates a new instance of the ReadWriteLockHelper class for the provided lock.

Parameters:

lock - the ReadWriteLock instance to wrap.

Method Detail

getLock

public java.util.concurrent.locks.ReadWriteLock getLock()

Gets the underlying ReadWriteLock instance.

Returns:

the underlying ReadWriteLock instance.

read

public ReadWriteLockHelper.LockHelper read()

Returns an helper providing methods to run lambdas within the context of the read lock.

Returns:

an helper providing methods to run lambdas within the context of the read lock.

write

public ReadWriteLockHelper.LockHelper write()

Returns an helper providing methods to run lambdas within the context of the write lock.

Returns:

an helper providing methods to run lambdas within the context of the write lock.