com.github.triceo.splitlog.expectations

Class MetricExpectationManager<T extends Number,P extends MessageProducer<P>>

java.lang.Object

com.github.triceo.splitlog.expectations.MetricExpectationManager<T,P>

All Implemented Interfaces:

MessageConsumer<P>, MessageListener<P>

public final class MetricExpectationManager<T extends Number,P extends MessageProducer<P>>
extends Object

Constructor Summary

Constructors

Constructor and Description
MetricExpectationManager(MessageMetric<T,P> metric)

Method Summary

Modifier and Type	Method and Description
boolean	isStopped() Whether or not MessageConsumer.stop() has been called.
void	messageReceived(Message msg, MessageDeliveryStatus status, P producer) Notify the code of a new message becoming available in the log.
Future<Message>	setExpectation(C condition) The resulting future will only return after such a message is received that makes the condition true.
Future<Message>	setExpectation(C condition, MessageAction<P> action) The resulting future will only return after such a message is received that makes the condition true.
boolean	stop() This consumer will no longer receive any messages.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricExpectationManager

public MetricExpectationManager(MessageMetric<T,P> metric)

Method Detail

isStopped

public boolean isStopped()

Description copied from interface: MessageConsumer

Whether or not MessageConsumer.stop() has been called.

Specified by:

isStopped in interface MessageConsumer<P extends MessageProducer<P>>

Returns:

True if called.

messageReceived

public void messageReceived(Message msg,
                            MessageDeliveryStatus status,
                            P producer)

Description copied from interface: MessageListener

Notify the code of a new message becoming available in the log. Although this method is public, it only serves as means of communication between Splitlog internals. It is forbidden for user code to ever call this method. Only the authorized sources, all part of Splitlog core, may use it.

Specified by:

messageReceived in interface MessageListener<P extends MessageProducer<P>>

Parameters:

msg - Message in question.

status - Current status of the message.

producer - The code that is notifying us of this event.

setExpectation

public Future<Message> setExpectation(C condition)

The resulting future will only return after such a message is received that makes the condition true.

Parameters:

condition - Condition to be true.

Returns:

The future.

setExpectation

public Future<Message> setExpectation(C condition,
                                      MessageAction<P> action)

The resulting future will only return after such a message is received that makes the condition true.

Parameters:

condition - Condition to be true.

Returns:

The future.

stop

public boolean stop()

Description copied from interface: MessageConsumer

This consumer will no longer receive any messages. It is the duty of implementors to make sure that MessageProducer do not send any more Messages here.

Specified by:

stop in interface MessageConsumer<P extends MessageProducer<P>>

Returns:

False if MessageConsumer.isStopped().