org.maestro.client.exchange

Class MaestroMonitor

java.lang.Object

org.maestro.client.exchange.MaestroMonitor

public class MaestroMonitor
extends Object

This class serves as a monitoring lock for asynchronous receipt of messages (usually, notifications). With this, the calling threads can be put to sleep until new messages matching the predicate have arrived. The responsibility of notifying them relies on the MaestroCollector which receives the messages.

Constructor Summary

Constructors

Constructor and Description
MaestroMonitor(Predicate<? super MaestroNote> object) Constructs a Monitor using the given predicate (ie.: note instanceof TestSuccessfulNotification)

Method Summary

Modifier and Type	Method and Description
void	doLock() Lock the execution
void	doLock(long timeout) Lock the execution
void	doUnlock() Unlock the execution
boolean	shouldAwake(MaestroNote subject) Tests if a subject matches the predicate

Methods inherited from class java.lang.Object

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

Constructor Detail

MaestroMonitor

public MaestroMonitor(Predicate<? super MaestroNote> object)

Constructs a Monitor using the given predicate (ie.: note instanceof TestSuccessfulNotification)

Parameters:

object - the monitoring predicate

Method Detail

doLock

public void doLock()
            throws InterruptedException

Lock the execution

Throws:

InterruptedException - if interrupted

doLock

public void doLock(long timeout)
            throws InterruptedException

Lock the execution

Throws:

InterruptedException - if interrupted

doUnlock

public void doUnlock()

Unlock the execution

shouldAwake

public boolean shouldAwake(MaestroNote subject)

Tests if a subject matches the predicate

Parameters:

subject - the subject to test (ie.: a new note arriving on the collector)

Returns:

true if it matches or false otherwise