Package com.plotsquared.core.synchronization

Class LockRepository

java.lang.Object

com.plotsquared.core.synchronization.LockRepository

public final class LockRepository
extends Object

A repository for keyed locks

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LockRepository.LockAccess

Constructor Summary

Constructors

Constructor	Description
LockRepository()

Method Summary

Modifier and Type	Method	Description
@NonNull Lock	getLock(@NonNull LockKey key)	Get the lock corresponding to the given lock key
@NonNull LockRepository.LockAccess	lock(@NonNull LockKey key)	Wait for a lock to be available, lock it and return an AutoCloseable instance that locks the key.
void	useLock(@NonNull LockKey key, @NonNull Runnable runnable)	Wait for the lock to become available, and run the given runnable, then unlock the lock.
void	useLock(@NonNull LockKey key, @NonNull Consumer<Lock> consumer)	Consume a lock

Methods inherited from class java.lang.Object

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

Constructor Details

LockRepository

public LockRepository()

Method Details

getLock

public @NonNull Lock getLock(@NonNull LockKey key)

Get the lock corresponding to the given lock key

Parameters:

key - Lock key

Returns:

Lock

useLock

public void useLock(@NonNull LockKey key,
 @NonNull Consumer<Lock> consumer)

Consume a lock

Parameters:

key - Lock key

consumer - Lock consumer

useLock

public void useLock(@NonNull LockKey key,
 @NonNull Runnable runnable)

Wait for the lock to become available, and run the given runnable, then unlock the lock. This is a blocking method.

Parameters:

key - Lock key

runnable - Action to run when the lock is available

lock

public @NonNull LockRepository.LockAccess lock(@NonNull LockKey key)

Wait for a lock to be available, lock it and return an AutoCloseable instance that locks the key.

This is meant to be used with try-with-resources, like such:

 try (final LockAccess lockAccess = lockRepository.lock(LockKey.of("your.key"))) {
      // use lock
 }
 

Parameters:

key - Lock key

Returns:

Lock access. Must be closed.