Package org.eclipse.aether.named.support

Class NamedLockSupport

java.lang.Object

org.eclipse.aether.named.support.NamedLockSupport

All Implemented Interfaces:

AutoCloseable, NamedLock

Direct Known Subclasses:

AdaptedSemaphoreNamedLock, CompositeNamedLock, FileLockNamedLock, ReadWriteLockNamedLock

public abstract class NamedLockSupport
extends Object
implements NamedLock

Support class for NamedLock implementations providing reference counting.

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor	Description
NamedLockSupport(NamedLockKey key, NamedLockFactorySupport factory)

Method Summary

Modifier and Type	Method	Description
final void	close()	Closes the lock resource.
Map<Thread,Deque<String>>	diagnosticState()	Returns the diagnostic state (if collected) or empty map, never null.
protected void	doClose()
protected abstract boolean	doLockExclusively(long time, TimeUnit unit)
protected abstract boolean	doLockShared(long time, TimeUnit unit)
protected abstract void	doUnlock()
NamedLockKey	key()	Returns this instance key, never null.
boolean	lockExclusively(long time, TimeUnit unit)	Tries to lock exclusively, may block for given time.
boolean	lockShared(long time, TimeUnit unit)	Tries to lock shared, may block for given time.
String	toString()
void	unlock()	Unlocks the lock, must be invoked by caller after one of the NamedLock.lockShared(long, TimeUnit) or NamedLock.lockExclusively(long, TimeUnit).

Methods inherited from class java.lang.Object

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

Field Details

logger

protected final org.slf4j.Logger logger

Constructor Details

NamedLockSupport

public NamedLockSupport(NamedLockKey key,
 NamedLockFactorySupport factory)

Method Details

key

public NamedLockKey key()

Description copied from interface: NamedLock

Returns this instance key, never null.

Specified by:

key in interface NamedLock

lockShared

public boolean lockShared(long time,
 TimeUnit unit)
                   throws InterruptedException

Description copied from interface: NamedLock

Tries to lock shared, may block for given time. If successful, returns true.

Specified by:

lockShared in interface NamedLock

Throws:

InterruptedException

doLockShared

protected abstract boolean doLockShared(long time,
 TimeUnit unit)
                                 throws InterruptedException

Throws:

InterruptedException

lockExclusively

public boolean lockExclusively(long time,
 TimeUnit unit)
                        throws InterruptedException

Description copied from interface: NamedLock

Tries to lock exclusively, may block for given time. If successful, returns true.

Specified by:

lockExclusively in interface NamedLock

Throws:

InterruptedException

doLockExclusively

protected abstract boolean doLockExclusively(long time,
 TimeUnit unit)
                                      throws InterruptedException

Throws:

InterruptedException

unlock

public void unlock()

Description copied from interface: NamedLock

Unlocks the lock, must be invoked by caller after one of the NamedLock.lockShared(long, TimeUnit) or NamedLock.lockExclusively(long, TimeUnit).

Specified by:

unlock in interface NamedLock

doUnlock

protected abstract void doUnlock()

close

public final void close()

Description copied from interface: NamedLock

Closes the lock resource. Lock MUST be unlocked using NamedLock.unlock() in case any locking happened on it. After invoking this method, the lock instance MUST NOT be used anymore. If lock for same name needed, a new instance should be obtained from factory using NamedLockFactory.getLock(java.util.Collection). Ideally, instances are to be used within try-with-resource blocks, so calling this method directly is not really needed, nor advised.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface NamedLock

doClose

protected void doClose()

diagnosticState

public Map<Thread,Deque<String>> diagnosticState()

Returns the diagnostic state (if collected) or empty map, never null.

Since:

1.9.11

toString

public String toString()

Overrides:

toString in class Object