uk.co.strangeskies.flowcontrol

Class StripedReadWriteLockImpl<K>

java.lang.Object

uk.co.strangeskies.flowcontrol.StripedReadWriteLockImpl<K>

Type Parameters:

K - the type of the keys by which locks are indexed

All Implemented Interfaces:

StripedReadWriteLock<K>, StripedReadWriteLockRelease<K>

public class StripedReadWriteLockImpl<K>
extends java.lang.Object
implements StripedReadWriteLock<K>

A simple StripedReadWriteLock implementation.

Constructor Summary

Constructors

Constructor and Description
StripedReadWriteLockImpl()

Method Summary

Modifier and Type	Method and Description
boolean	downgradeLock(K key)
boolean	isLockHeldByCurrentThread(K key)
boolean	isReadLockHeldByCurrentThread(K key)
boolean	isWriteLockHeldByCurrentThread(K key)
void	obtainLocks(java.util.Collection<K> readKeys, java.util.Collection<K> writeKeys) Multiple concurrent calls from different threads do not lock.
void	obtainReadLocks(java.util.Collection<K> readKeys) Multiple concurrent calls from different threads do not lock.
void	obtainWriteLocks(java.util.Collection<K> writeKeys) Multiple concurrent calls from different threads do not lock.
java.util.Set<K>	readLocksHeldByCurrentThread()
boolean	releaseLock(K key)
boolean	releaseLocks(java.util.Collection<? extends K> keys)
boolean	releaseLocks(java.util.Collection<? extends K> readKeys, java.util.Collection<? extends K> writeKeys)
boolean	releaseReadLock(K key)
boolean	releaseReadLocks(java.util.Collection<? extends K> readKeys)
boolean	releaseWriteLock(K key)
boolean	releaseWriteLocks(java.util.Collection<? extends K> writeKeys)
protected boolean	silentlyDowngradeLock(K key)
protected boolean	silentlyReleaseReadLock(K key)
protected boolean	silentlyReleaseWriteLock(K key)
protected boolean	tryToObtainReadLock(K key)
protected boolean	tryToObtainWriteLock(K key)
void	wait(K key) Wait for the given lock to become available.
void	wait(K key, long milliseconds) Wait for the given lock to become available.
void	wait(K key, long milliseconds, int nanoseconds) Wait for the given lock to become available.
java.util.Set<K>	writeLocksHeldByCurrentThread()

Methods inherited from class java.lang.Object

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

Constructor Detail

StripedReadWriteLockImpl

public StripedReadWriteLockImpl()

Method Detail

readLocksHeldByCurrentThread

public java.util.Set<K> readLocksHeldByCurrentThread()

Specified by:

readLocksHeldByCurrentThread in interface StripedReadWriteLockRelease<K>

writeLocksHeldByCurrentThread

public java.util.Set<K> writeLocksHeldByCurrentThread()

Specified by:

writeLocksHeldByCurrentThread in interface StripedReadWriteLockRelease<K>

obtainReadLocks

public final void obtainReadLocks(java.util.Collection<K> readKeys)
                           throws java.lang.InterruptedException

Description copied from interface: StripedReadWriteLock

Multiple concurrent calls from different threads do not lock. Blocks until all locks can be obtained (or until interruption).

Specified by:

obtainReadLocks in interface StripedReadWriteLock<K>

Parameters:

readKeys - Keys for read locks to be obtained

Throws:

java.lang.InterruptedException - The obtaining thread was interrupted before the locks could be obtained.

obtainWriteLocks

public final void obtainWriteLocks(java.util.Collection<K> writeKeys)
                            throws java.lang.InterruptedException

Description copied from interface: StripedReadWriteLock

Multiple concurrent calls from different threads do not lock. Blocks until all locks can be obtained (or until interruption).

Specified by:

obtainWriteLocks in interface StripedReadWriteLock<K>

Parameters:

writeKeys - Keys for write locks to be obtained

Throws:

java.lang.InterruptedException - The obtaining thread was interrupted before the locks could be obtained.

obtainLocks

public final void obtainLocks(java.util.Collection<K> readKeys,
                              java.util.Collection<K> writeKeys)
                       throws java.lang.InterruptedException

Description copied from interface: StripedReadWriteLock

Multiple concurrent calls from different threads do not lock. Blocks until all locks can be obtained (or until interruption).

Specified by:

obtainLocks in interface StripedReadWriteLock<K>

Parameters:

readKeys - Keys for read locks to be obtained

writeKeys - Keys for write locks to be obtained

Throws:

java.lang.InterruptedException - The obtaining thread was interrupted before the locks could be obtained.

releaseReadLocks

public final boolean releaseReadLocks(java.util.Collection<? extends K> readKeys)

Specified by:

releaseReadLocks in interface StripedReadWriteLockRelease<K>

releaseWriteLocks

public final boolean releaseWriteLocks(java.util.Collection<? extends K> writeKeys)

Specified by:

releaseWriteLocks in interface StripedReadWriteLockRelease<K>

releaseLocks

public boolean releaseLocks(java.util.Collection<? extends K> keys)

Specified by:

releaseLocks in interface StripedReadWriteLockRelease<K>

releaseLocks

public final boolean releaseLocks(java.util.Collection<? extends K> readKeys,
                                  java.util.Collection<? extends K> writeKeys)

Specified by:

releaseLocks in interface StripedReadWriteLockRelease<K>

releaseReadLock

public final boolean releaseReadLock(K key)

Specified by:

releaseReadLock in interface StripedReadWriteLockRelease<K>

releaseWriteLock

public final boolean releaseWriteLock(K key)

Specified by:

releaseWriteLock in interface StripedReadWriteLockRelease<K>

downgradeLock

public final boolean downgradeLock(K key)

Specified by:

downgradeLock in interface StripedReadWriteLockRelease<K>

releaseLock

public final boolean releaseLock(K key)

Specified by:

releaseLock in interface StripedReadWriteLockRelease<K>

tryToObtainReadLock

protected final boolean tryToObtainReadLock(K key)

tryToObtainWriteLock

protected final boolean tryToObtainWriteLock(K key)

silentlyReleaseReadLock

protected final boolean silentlyReleaseReadLock(K key)

silentlyReleaseWriteLock

protected final boolean silentlyReleaseWriteLock(K key)

silentlyDowngradeLock

protected final boolean silentlyDowngradeLock(K key)

isLockHeldByCurrentThread

public boolean isLockHeldByCurrentThread(K key)

Specified by:

isLockHeldByCurrentThread in interface StripedReadWriteLockRelease<K>

isReadLockHeldByCurrentThread

public boolean isReadLockHeldByCurrentThread(K key)

Specified by:

isReadLockHeldByCurrentThread in interface StripedReadWriteLockRelease<K>

isWriteLockHeldByCurrentThread

public boolean isWriteLockHeldByCurrentThread(K key)

Specified by:

isWriteLockHeldByCurrentThread in interface StripedReadWriteLockRelease<K>

wait

public void wait(K key)
          throws java.lang.InterruptedException

Description copied from interface: StripedReadWriteLock

Wait for the given lock to become available.

Specified by:

wait in interface StripedReadWriteLock<K>

Parameters:

key - The key to the lock on which we wish to wait.

Throws:

java.lang.InterruptedException - The waiting thread was interrupted before the lock could be obtained.

wait

public void wait(K key,
                 long milliseconds)
          throws java.lang.InterruptedException

Description copied from interface: StripedReadWriteLock

Wait for the given lock to become available.

Specified by:

wait in interface StripedReadWriteLock<K>

Parameters:

key - The key to the lock on which we wish to wait.

milliseconds - The timeout in milliseconds to wait.

Throws:

java.lang.InterruptedException - The waiting thread was interrupted before the lock could be obtained.

wait

public void wait(K key,
                 long milliseconds,
                 int nanoseconds)
          throws java.lang.InterruptedException

Description copied from interface: StripedReadWriteLock

Wait for the given lock to become available.

Specified by:

wait in interface StripedReadWriteLock<K>

Parameters:

key - The key to the lock on which we wish to wait.

milliseconds - The timeout component in milliseconds to wait.

nanoseconds - The timeout component in nanoseconds to wait.

Throws:

java.lang.InterruptedException - The waiting thread was interrupted before the lock could be obtained.