ca.odell.glazedlists

Class Guard

java.lang.Object

ca.odell.glazedlists.Guard

public final class Guard
extends java.lang.Object

A helper class for guarding executable code (in the form of Consumer or Function objects) with read or write locks on an EventList.

These methods complement the corresponding default methods in the EventList interface. Whereas those methods only expose EventList methods to the Consumer or Function objects, these methods here expose the EventList implementation class and therefore offer more methods to use.

For example:

 
 EventList<String> source = ...
 TransactionList<String> transactionList = new TransactionList<>(source);
 Guard.acceptWithWriteLock(transactionList, txList -> {
      txList.beginEvent(true);
      txList.add("A new element");
      txList.set(0, "A changed element");
      txList.remove(6);
      txList.commitEvent();
 });
 
 

Method Summary

Modifier and Type	Method and Description
static <E,L extends EventList<E>> void	acceptWithReadLock(L eventList, java.util.function.Consumer<L> consumer) Executes the block of code represented by the given consumer while holding the read lock of the supplied EventList.
static <E,L extends EventList<E>> void	acceptWithWriteLock(L eventList, java.util.function.Consumer<L> consumer) Executes the block of code represented by the given consumer while holding the write lock of the supplied EventList.
static <E,L extends EventList<E>,R> R	applyWithReadLock(L list, java.util.function.Function<L,R> function) Applies the given function to the supplied EventList while holding the read lock of this EventList.
static <E,L extends EventList<E>,R> R	applyWithWriteLock(L list, java.util.function.Function<L,R> function) Applies the given function to the supplied EventList while holding the write lock of this EventList.

Methods inherited from class java.lang.Object

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

Method Detail

acceptWithReadLock

public static <E,L extends EventList<E>> void acceptWithReadLock(L eventList,
                                                                 java.util.function.Consumer<L> consumer)

Executes the block of code represented by the given consumer while holding the read lock of the supplied EventList.

Type Parameters:

E - the element type of the list

L - the concrete list type

Parameters:

list - EventList

consumer - the consumer != null

See Also:

EventList.acceptWithReadLock(Consumer)

acceptWithWriteLock

public static <E,L extends EventList<E>> void acceptWithWriteLock(L eventList,
                                                                  java.util.function.Consumer<L> consumer)

Executes the block of code represented by the given consumer while holding the write lock of the supplied EventList.

Type Parameters:

E - the element type of the list

L - the concrete list type

Parameters:

list - EventList

consumer - the consumer != null

See Also:

EventList.acceptWithWriteLock(Consumer)

applyWithReadLock

public static <E,L extends EventList<E>,R> R applyWithReadLock(L list,
                                                               java.util.function.Function<L,R> function)

Applies the given function to the supplied EventList while holding the read lock of this EventList.

Type Parameters:

E - the element type of the list

L - the concrete list type

R - the result type of the function

Parameters:

list - EventList != null

function - the function != null

Returns:

the result of the function

See Also:

EventList.applyWithReadLock(Function)

applyWithWriteLock

public static <E,L extends EventList<E>,R> R applyWithWriteLock(L list,
                                                                java.util.function.Function<L,R> function)

Applies the given function to the supplied EventList while holding the write lock of this EventList.

Type Parameters:

E - the element type of the list

L - the concrete list type

R - the result type of the function

Parameters:

list - EventList != null

function - the function != null

Returns:

the result of the function

See Also:

EventList.applyWithWriteLock(Function)