org.threadly.concurrent.lock

Class StripedLock

java.lang.Object

org.threadly.concurrent.lock.StripedLock

public class StripedLock
extends java.lang.Object

This structure allows for more controlled levels of parallelism. It helps in allowing threads to only lock when their interest are the same. It is guaranteed that every key provided will return the same lock. But it is not guaranteed that two different keys will not have the same lock.

Currently this class only provides objects that should be synchronized on. Compared to Lock objects which have lock(), tryLock(), and unlock() functionality. This choice was primarily because of the way the internals of threadly work.

Since:

1.0.0

Constructor Summary

Constructors

Constructor and Description
StripedLock(int expectedConcurrencyLevel) Constructs a new StripedLock with a given expected concurrency level.

Method Summary

Modifier and Type	Method and Description
int	getExpectedConcurrencyLevel() Getter for the expected concurrency level this class was constructed with.
java.lang.Object	getLock(int hashCode) Call to get a lock object for a given hash code.
java.lang.Object	getLock(java.lang.Object key) Call to get a lock object for a given key.

Methods inherited from class java.lang.Object

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

Constructor Detail

StripedLock

public StripedLock(int expectedConcurrencyLevel)

Constructs a new StripedLock with a given expected concurrency level. The higher the concurrency level, the less lock contention will exist, but more locks will have to be synchronized on and more memory will be used to store the locks.

Parameters:

expectedConcurrencyLevel - expected level of parallelism

Method Detail

getExpectedConcurrencyLevel

public int getExpectedConcurrencyLevel()

Getter for the expected concurrency level this class was constructed with.

Returns:

the constructed level of concurrency

getLock

public java.lang.Object getLock(java.lang.Object key)

Call to get a lock object for a given key.

Parameters:

key - to use hashCode() from to determine lock

Returns:

consistent Object for a given key

getLock

public java.lang.Object getLock(int hashCode)

Call to get a lock object for a given hash code.

Parameters:

hashCode - to use to determine which lock to return

Returns:

consistent Object for a given hash code