Package io.deephaven.util.locks

Interface FunctionalLock

All Superinterfaces:

Lock

All Known Subinterfaces:

AwareFunctionalLock

All Known Implementing Classes:

FunctionalReentrantLock

public interface FunctionalLock
extends Lock

Extension to the Lock interface to enable locking for the duration of a lambda or other FunctionalInterface invocation.

Method Summary

Modifier and Type	Method	Description
default <RESULT_TYPE, EXCEPTION_TYPE extends Exception> RESULT_TYPE	computeLocked(@NotNull ThrowingSupplier<RESULT_TYPE,EXCEPTION_TYPE> supplier)	Acquire the lock, invoke ThrowingSupplier.get() while holding the lock, and release the lock before returning the result.
default <RESULT_TYPE, EXCEPTION_TYPE extends Exception> RESULT_TYPE	computeLockedInterruptibly(@NotNull ThrowingSupplier<RESULT_TYPE,EXCEPTION_TYPE> supplier)	Acquire the lock interruptibly, invoke ThrowingSupplier.get() while holding the lock, and release the lock before returning the result.
default <EXCEPTION_TYPE extends Exception> void	doLocked(@NotNull ThrowingRunnable<EXCEPTION_TYPE> runnable)	Acquire the lock, invoke ThrowingRunnable.run() while holding the lock, and release the lock before returning.
default <EXCEPTION_TYPE extends Exception> void	doLockedInterruptibly(@NotNull ThrowingRunnable<EXCEPTION_TYPE> runnable)	Acquire the lock interruptibly, invoke ThrowingRunnable.run() while holding the lock, and release the lock before returning.
default SafeCloseable	lockCloseable()	Acquire the lock via Lock.lock() and return a SafeCloseable that calls Lock.unlock() on SafeCloseable.close().
default SafeCloseable	lockInterruptiblyCloseable()	Acquire the lock via Lock.lockInterruptibly() and return a SafeCloseable that calls Lock.unlock() on SafeCloseable.close().
default <EXCEPTION_TYPE extends Exception> boolean	testLocked(@NotNull ThrowingBooleanSupplier<EXCEPTION_TYPE> supplier)	Acquire the lock, invoke ThrowingBooleanSupplier.getAsBoolean() while holding the lock, and release the lock before returning the result.

Methods inherited from interface java.util.concurrent.locks.Lock

lock, lockInterruptibly, newCondition, tryLock, tryLock, unlock

Method Details

doLocked

default <EXCEPTION_TYPE extends Exception> void doLocked(@NotNull
 @NotNull ThrowingRunnable<EXCEPTION_TYPE> runnable)
                                                  throws EXCEPTION_TYPE

Acquire the lock, invoke ThrowingRunnable.run() while holding the lock, and release the lock before returning.

Parameters:

runnable - The ThrowingRunnable to run

Throws:

EXCEPTION_TYPE - If runnable throws its declared exception

doLockedInterruptibly

default <EXCEPTION_TYPE extends Exception> void doLockedInterruptibly(@NotNull
 @NotNull ThrowingRunnable<EXCEPTION_TYPE> runnable)
                                                               throws InterruptedException,
EXCEPTION_TYPE

Acquire the lock interruptibly, invoke ThrowingRunnable.run() while holding the lock, and release the lock before returning.

Parameters:

runnable - The ThrowingRunnable.run() to run

Throws:

InterruptedException - If the current thread was interrupted while waiting to acquire the lock

EXCEPTION_TYPE - If runnable throws its declared exception

computeLocked

default <RESULT_TYPE,
EXCEPTION_TYPE extends Exception>
RESULT_TYPE computeLocked(@NotNull
 @NotNull ThrowingSupplier<RESULT_TYPE,EXCEPTION_TYPE> supplier)
                   throws EXCEPTION_TYPE

Acquire the lock, invoke ThrowingSupplier.get() while holding the lock, and release the lock before returning the result.

Parameters:

supplier - The ThrowingSupplier to get

Returns:

The result of invoking supplier

Throws:

EXCEPTION_TYPE - If supplier throws its declared exception

testLocked

default <EXCEPTION_TYPE extends Exception> boolean testLocked(@NotNull
 @NotNull ThrowingBooleanSupplier<EXCEPTION_TYPE> supplier)
                                                       throws EXCEPTION_TYPE

Acquire the lock, invoke ThrowingBooleanSupplier.getAsBoolean() while holding the lock, and release the lock before returning the result.

Parameters:

supplier - The ThrowingBooleanSupplier to get

Returns:

The result of invoking supplier

Throws:

EXCEPTION_TYPE - If supplier throws its declared exception

computeLockedInterruptibly

default <RESULT_TYPE,
EXCEPTION_TYPE extends Exception>
RESULT_TYPE computeLockedInterruptibly(@NotNull
 @NotNull ThrowingSupplier<RESULT_TYPE,EXCEPTION_TYPE> supplier)
                                throws InterruptedException,
EXCEPTION_TYPE

Acquire the lock interruptibly, invoke ThrowingSupplier.get() while holding the lock, and release the lock before returning the result.

Parameters:

supplier - The ThrowingSupplier to get

Returns:

The result of invoking supplier

Throws:

InterruptedException - If the current thread was interrupted while waiting to acquire the lock

EXCEPTION_TYPE - If supplier throws its declared exception

lockCloseable

default SafeCloseable lockCloseable()

Acquire the lock via Lock.lock() and return a SafeCloseable that calls Lock.unlock() on SafeCloseable.close().

Returns:

the safe closeable

lockInterruptiblyCloseable

default SafeCloseable lockInterruptiblyCloseable()
                                          throws InterruptedException

Acquire the lock via Lock.lockInterruptibly() and return a SafeCloseable that calls Lock.unlock() on SafeCloseable.close().

Returns:

the safe closeable

Throws:

InterruptedException