org.infinispan.commons.util

Class Notifier<T>

java.lang.Object

org.infinispan.commons.util.Notifier<T>

public class Notifier<T>
extends Object

A notification barrier that makes threads waiting until they are notified.

The semantic is similar as new CountDownLatch(1) but it allows listeners to be added. The listeners can be any class and they are invoked when the method fireListener() is invoked. Threads invoking await(long, TimeUnit) will be unblocked too.

Since:

8.0

Author:

Pedro Ruivo

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Notifier.Invoker<T1>

Constructor Summary

Constructors

Constructor and Description
Notifier(Notifier.Invoker<T> invoker) Constructs a new instance.

Method Summary

Modifier and Type	Method and Description
void	add(T listener) Adds a listener.
boolean	await(long time, TimeUnit unit) Makes the thread waiting until fireListener() is invoked or the specified waiting time elapses.
void	fireListener() Unblocks all the waiting threads and notifies the listeners.

Methods inherited from class java.lang.Object

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

Constructor Detail

Notifier

public Notifier(Notifier.Invoker<T> invoker)

Constructs a new instance.

Parameters:

invoker - the Notifier.Invoker is invoked with the listener to be notified.

Throws:

NullPointerException - if invoker is null.

Method Detail

add

public void add(T listener)

Adds a listener.

If the method fireListener() was already invoked, the listener could be invoked by the invocation thread. The listener is invoked only once.

Parameters:

listener - the listener to invoke.

Throws:

NullPointerException - if the listener is null.

await

public boolean await(long time,
                     TimeUnit unit)
              throws InterruptedException

Makes the thread waiting until fireListener() is invoked or the specified waiting time elapses.

Parameters:

time - the maximum time to wait

unit - the time unit of the time

Returns:

true if another thread invoked fireListener(), false otherwise.

Throws:

InterruptedException - if the current thread is interrupted while waiting

NullPointerException - if unit is null.

fireListener

public void fireListener()

Unblocks all the waiting threads and notifies the listeners. If this method was previously invoked, then nothing happens.