Module org.tquadrat.foundation.base

Package org.tquadrat.foundation.lang.internal

Class LockExecutorImpl

java.lang.Object

org.tquadrat.foundation.lang.internal.LockExecutorImpl

All Implemented Interfaces:

LockExecutor

@ClassVersion(sourceVersion="$Id: LockExecutorImpl.java 1097 2024-02-06 20:10:12Z tquadrat $")
@API(status=INTERNAL,
     since="0.1.0")
public final class LockExecutorImpl
extends Object
implements LockExecutor

The implementation of LockExecutor.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: LockExecutorImpl.java 1097 2024-02-06 20:10:12Z tquadrat $

Since:

0.1.0

UML Diagram

⁠

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

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final AutoLock	m_Lock	The lock.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	LockExecutorImpl(AutoLock lock)	Creates an instance of LockExecutorImpl.

Method Summary

Modifier and Type	Method	Description
boolean	evaluate(Constraint constraint)	Evaluates the given condition.
void	execute(Action action)	Executes the given action.
<T> Optional<T>	execute(Operation<T> operation)	Executes the given operation.
static final LockExecutor	of(Lock lock)	Creates a new LockExecutor from the given Lock instance.
static final LockExecutor	of(AutoLock lock)	Creates a new LockExecutor from the given 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 AutoLock m_Lock

The lock.

Constructor Details

LockExecutorImpl

private LockExecutorImpl(AutoLock lock)

Creates an instance of LockExecutorImpl.

Parameters:

lock - The lock.

Method Details

evaluate

public boolean evaluate(Constraint constraint)
                 throws AutoLock.ExecutionFailedException

Evaluates the given condition.

Specified by:

evaluate in interface LockExecutor

Parameters:

constraint - The constraint.

Returns:

The result of the evaluation of the condition.

Throws:

AutoLock.ExecutionFailedException - The evaluation failed for some reason.

execute

public void execute(Action action)
             throws AutoLock.ExecutionFailedException

Executes the given action.

Specified by:

execute in interface LockExecutor

Parameters:

action - The action.

Throws:

AutoLock.ExecutionFailedException - The action failed for some reason.

execute

public <T> Optional<T> execute(Operation<T> operation)
                        throws AutoLock.ExecutionFailedException

Executes the given operation.

Specified by:

execute in interface LockExecutor

Type Parameters:

T - The type of the operation's result.

Parameters:

operation - The operation.

Returns:

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

Throws:

AutoLock.ExecutionFailedException - The operation failed for some reason.

of

public static final LockExecutor of(Lock lock)

Creates a new LockExecutor from the given Lock instance.

Parameters:

lock - The lock.

Returns:

The new LockExecutor.

of

public static final LockExecutor of(AutoLock lock)

Creates a new LockExecutor from the given AutoLock instance.

Parameters:

lock - The lock.

Returns:

The new LockExecutor.