org.jadice.util.concurrent

Class ListenablePhaser

java.lang.Object

java.util.concurrent.Phaser

org.jadice.util.concurrent.ListenablePhaser

public class ListenablePhaser
extends Phaser

A Phaser which notifies registered listener on phase advances.

Since:

jadice utils 1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListenablePhaser.PhaserListener Implementations are able to receive notifications about phase advances in a ListenablePhaser.

Constructor Summary

Constructors

Constructor and Description
ListenablePhaser()

Method Summary

Modifier and Type	Method and Description
void	addPhaserListener(ListenablePhaser.PhaserListener listener) Registers the given instance to be notified on phase changes.
protected boolean	onAdvance(int phase, int registeredParties)
void	removePhaserListener(ListenablePhaser.PhaserListener listener) Deregisters the given instance so that it will no longer be notified.
protected boolean	shallTerminate(int phase, int registeredParties) Template-method which can be overridden to perform the functionality which would usually be implemented in onAdvance(int, int) directly.

Methods inherited from class java.util.concurrent.Phaser

arrive, arriveAndAwaitAdvance, arriveAndDeregister, awaitAdvance, awaitAdvanceInterruptibly, awaitAdvanceInterruptibly, bulkRegister, forceTermination, getArrivedParties, getParent, getPhase, getRegisteredParties, getRoot, getUnarrivedParties, isTerminated, register, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ListenablePhaser

public ListenablePhaser()

Method Detail

addPhaserListener

public void addPhaserListener(ListenablePhaser.PhaserListener listener)

Registers the given instance to be notified on phase changes.

Parameters:

listener - the instance to be registered. Must not be null. If it is already registered, nothing happens.

removePhaserListener

public void removePhaserListener(ListenablePhaser.PhaserListener listener)

Deregisters the given instance so that it will no longer be notified.

Parameters:

listener - the instance to be deregistered. If it is null or hasn't been registered before, nothing happens.

onAdvance

protected boolean onAdvance(int phase,
                            int registeredParties)

Overrides:

onAdvance in class Phaser

shallTerminate

protected boolean shallTerminate(int phase,
                                 int registeredParties)

Template-method which can be overridden to perform the functionality which would usually be implemented in onAdvance(int, int) directly.

Parameters:

phase - see Phaser.onAdvance(int, int)

registeredParties - see Phaser.onAdvance(int, int)

Returns:

true if this phaser should terminate