net.digitalid.utility.concurrency.lock

Class NonReentrantLock

java.lang.Object

net.digitalid.utility.rootclass.RootClassWithException<RuntimeException>

net.digitalid.utility.rootclass.RootClass

net.digitalid.utility.concurrency.lock.NonReentrantLock

All Implemented Interfaces:

Lock, net.digitalid.utility.casting.Castable, net.digitalid.utility.interfaces.Locking, net.digitalid.utility.rootclass.RootInterface, net.digitalid.utility.validation.validatable.Validatable

@Mutable
 @ThreadSafe
 @GenerateBuilder
 @GenerateSubclass
public abstract class NonReentrantLock
extends net.digitalid.utility.rootclass.RootClass
implements Lock, net.digitalid.utility.interfaces.Locking

This class implements a non-reentrant lock which throws a PreconditionException if a thread tries to acquire a non-reentrant lock that it already holds.

It is highly recommended that you always follow a (successful) call to one of the lock methods immediately with a try-finally block like

 lock.lock();
 try {
     // Do the synchronized operations here.
 } finally {
     lock.unlock();
 }
 

Constructor Summary

Constructors

Constructor and Description
NonReentrantLock()

Method Summary

Modifier and Type	Method and Description
abstract @Nonnull ReentrantLock	getReentrantLock() Returns the fair reentrant lock which is used to implement this non-reentrant lock.
boolean	isLockHeldByCurrentThread()
void	lock()
void	lockInterruptibly()
@Nonnull Condition	newCondition()
boolean	tryLock()
boolean	tryLock(long time, @Nonnull TimeUnit unit)
void	unlock()

Methods inherited from class net.digitalid.utility.rootclass.RootClassWithException

equals, hashCode, initialize, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.digitalid.utility.casting.Castable

castTo

Methods inherited from interface net.digitalid.utility.validation.validatable.Validatable

validate

Constructor Detail

NonReentrantLock

public NonReentrantLock()

Method Detail

getReentrantLock

@Pure
 @Derive(value="new ReentrantLock(true)")
 @Nonnull
public abstract @Nonnull ReentrantLock getReentrantLock()

Returns the fair reentrant lock which is used to implement this non-reentrant lock. This method intentionally allows to acquire the lock reentrantly for special cases.

lock

@Impure
 @LockNotHeldByCurrentThread
public void lock()

Specified by:

lock in interface Lock

lockInterruptibly

@Impure
 @LockNotHeldByCurrentThread
public void lockInterruptibly()
                                                            throws InterruptedException

Specified by:

lockInterruptibly in interface Lock

Throws:

InterruptedException

tryLock

@Impure
 @LockNotHeldByCurrentThread
public boolean tryLock()

Specified by:

tryLock in interface Lock

tryLock

@Impure
 @LockNotHeldByCurrentThread
public boolean tryLock(long time,
                                                            @Nonnull
                                                            @Nonnull TimeUnit unit)
                                                     throws InterruptedException

Specified by:

tryLock in interface Lock

Throws:

InterruptedException

unlock

@Impure
public void unlock()

Specified by:

unlock in interface Lock

newCondition

@Impure
 @Nonnull
public @Nonnull Condition newCondition()

Specified by:

newCondition in interface Lock

isLockHeldByCurrentThread

@Pure
public boolean isLockHeldByCurrentThread()

Specified by:

isLockHeldByCurrentThread in interface net.digitalid.utility.interfaces.Locking