ch.awae.utils

Class AccessFlag

java.lang.Object

ch.awae.utils.AccessFlag

public final class AccessFlag
extends java.lang.Object

Access Flags encapsulate the access flag pattern where a flag is used to enable or disable access to certain functions.

Since:

awaeUtils 1.0.2

Author:

Andreas Wälchli

Constructor Summary

Constructors

Constructor and Description
AccessFlag()
AccessFlag(boolean locked)
AccessFlag(boolean locked, java.util.function.Supplier<java.lang.RuntimeException> exceptionSupplier)
AccessFlag(java.lang.String name)
AccessFlag(java.lang.String name, boolean locked)

Method Summary

Modifier and Type	Method and Description
boolean	isLocked()
void	lock()
void	lockWhile(java.lang.Runnable runnable) Tests if the access is locked.
void	test() Tests if the access is locked.
void	testAndLock() Tests if the access is locked.
void	toggleLock()
void	unlock()

Methods inherited from class java.lang.Object

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

Constructor Detail

AccessFlag

public AccessFlag()

AccessFlag

public AccessFlag(java.lang.String name)

AccessFlag

public AccessFlag(boolean locked)

AccessFlag

public AccessFlag(java.lang.String name,
                  boolean locked)

AccessFlag

public AccessFlag(boolean locked,
                  java.util.function.Supplier<java.lang.RuntimeException> exceptionSupplier)

Method Detail

lock

public void lock()

unlock

public void unlock()

toggleLock

public void toggleLock()

isLocked

public boolean isLocked()

test

public void test()

Tests if the access is locked. If it is locked an exception is thrown. By default this is an IllegalStateException.

testAndLock

public void testAndLock()

Tests if the access is locked. Locks if unlocked. If it is locked an exception is thrown. By default this is an IllegalStateException. If it is unlocked, it will be locked.

lockWhile

public void lockWhile(java.lang.Runnable runnable)

Tests if the access is locked. Locks if unlocked, executes the provided Runnable and then unlocks. If it is locked an exception is thrown. By default this is an IllegalStateException. If the runnable throws an exception, the lock will not be lifted!

Parameters:

runnable - the runnable to execute during the locked period