Module org.tquadrat.foundation.base

Package org.tquadrat.foundation.lang.internal

Class AutoLockImpl

java.lang.Object

org.tquadrat.foundation.lang.internal.AutoLockImpl

All Implemented Interfaces:

AutoCloseable, AutoLock

@ClassVersion(sourceVersion="$Id: AutoLockImpl.java 1135 2024-05-28 21:32:48Z tquadrat $")
@API(status=INTERNAL,
     since="0.1.0")
public final class AutoLockImpl
extends Object
implements AutoLock

The implementation of AutoLock.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: AutoLockImpl.java 1135 2024-05-28 21:32:48Z tquadrat $

Since:

0.1.0

See Also:

• Lock

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.lang.internal.AutoLockImpl"

⁠

Nested Class Summary

Nested classes/interfaces inherited from interface org.tquadrat.foundation.lang.AutoLock

AutoLock.ExecutionFailedException

Field Summary

Fields

Modifier and Type	Field	Description
private final Lock	m_Lock	The wrapped lock.

Constructor Summary

Constructors

Constructor	Description
AutoLockImpl()	Creates a new AutoLockImpl instance with an internal lock object.
AutoLockImpl(Lock lock)	Creates a new AutoLockImpl instance.

Method Summary

Modifier and Type	Method	Description
final void	close()
final boolean	evaluate(Constraint constraint)	Evaluates the given Constraint after obtaining the lock, and returns its result.
void	execute(Action action)	Executes the given action after obtaining the lock.
<R> Optional<R>	execute(Operation<? extends R> verification)	Executes the given operation after obtaining the lock, and returns its result.
final Lock	getWrappedLockInstance()	Returns the wrapped lock.
final AutoLock	lock()	Calls lock() on the wrapped Lock instance.
final AutoLock	lockInterruptibly()	Calls lockInterruptibly() on the wrapped Lock instance.
final Condition	newCondition()	Returns a new Condition instance that is bound to the instance of Lock that is wrapped by this AutoLock instance.

Methods inherited from class java.lang.Object

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

Field Details

m_Lock

private final Lock m_Lock

The wrapped lock.

Constructor Details

AutoLockImpl

public AutoLockImpl(Lock lock)

Creates a new AutoLockImpl instance.

Parameters:

lock - The wrapped lock.

AutoLockImpl

public AutoLockImpl()

Creates a new AutoLockImpl instance with an internal lock object.

Method Details

close

public final void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface AutoLock

evaluate

public final boolean evaluate(Constraint constraint)
                       throws AutoLock.ExecutionFailedException

Evaluates the given Constraint after obtaining the lock, and returns its result.

Specified by:

evaluate in interface AutoLock

Parameters:

constraint - The constraint

Returns:

The evaluation result.

Throws:

AutoLock.ExecutionFailedException - The evaluation failed for some reason.

execute

public void execute(Action action)
             throws AutoLock.ExecutionFailedException

Executes the given action after obtaining the lock.

Specified by:

execute in interface AutoLock

Parameters:

action - The action.

Throws:

AutoLock.ExecutionFailedException - The action failed for some reason.

execute

public <R> Optional<R> execute(Operation<? extends R> verification)
                        throws AutoLock.ExecutionFailedException

Executes the given operation after obtaining the lock, and returns its result.

Specified by:

execute in interface AutoLock

Type Parameters:

R - The type of the operation's result.

Parameters:

verification - The operation.

Returns:

An instance of Optional that holds the result of the operation.

Throws:

AutoLock.ExecutionFailedException - The operation failed for some reason.

getWrappedLockInstance

public final Lock getWrappedLockInstance()

Returns the wrapped lock.

Specified by:

getWrappedLockInstance in interface AutoLock

Returns:

The wrapped lock.

lock

public final AutoLock lock()

Calls lock() on the wrapped Lock instance.

Specified by:

lock in interface AutoLock

Returns:

The reference to this AutoLock instance.

lockInterruptibly

public final AutoLock lockInterruptibly()
                                 throws InterruptedException

Calls lockInterruptibly() on the wrapped Lock instance.

Specified by:

lockInterruptibly in interface AutoLock

Returns:

The reference to this AutoLock instance.

Throws:

InterruptedException - The current thread was interrupted while acquiring the lock (and interruption of lock acquisition is supported).

newCondition

public final Condition newCondition()

Returns a new Condition instance that is bound to the instance of Lock that is wrapped by this AutoLock instance.

Specified by:

newCondition in interface AutoLock

Returns:

The new condition.

See Also:

• Lock.newCondition()