com.github.triceo.splitlog.api

Interface Follower

All Superinterfaces:

CommonFollower<Follower,LogWatch>, MessageConsumer<LogWatch>, MessageListener<LogWatch>, MessageProducer<Follower>

public interface Follower
extends CommonFollower<Follower,LogWatch>, MessageProducer<Follower>

On top of the CommonFollower's functions, this allows for merging followers.

Method Summary

Modifier and Type	Method and Description
Future<Message>	expect(C condition) Will return a future that will only return when a message arrives that makes the given condition return true.
Future<Message>	expect(C condition, MessageAction<S> action) Will return a future that will only return when a message arrives that makes the given condition return true, at which point it asynchronously executes a particular action.
LogWatch	getFollowed() Retrieve the log watch that is being followed.
Message	tag(String tagLine) Mark the current location in the tail by a custom message.

Methods inherited from interface com.github.triceo.splitlog.api.CommonFollower

getMessages, getMessages, getMessages, getMessages, mergeWith, mergeWith, write, write, write, write, write, write, write, write

Methods inherited from interface com.github.triceo.splitlog.api.MessageProducer

countConsumers, countMetrics, getMetric, getMetricId, isConsuming, isMeasuring, isMeasuring, startConsuming, startMeasuring, stopConsuming, stopMeasuring, stopMeasuring

Methods inherited from interface com.github.triceo.splitlog.api.MessageConsumer

isStopped, stop

Methods inherited from interface com.github.triceo.splitlog.api.MessageListener

messageReceived

Method Detail

getFollowed

LogWatch getFollowed()

Retrieve the log watch that is being followed.

Returns:

The LogWatch whose LogWatch.startFollowing() was called to obtain reference to this follower.

tag

Message tag(String tagLine)

Mark the current location in the tail by a custom message. In case the messages before and after the tag should be discarded in the future, the tag should still remain in place - this will give users the notification that some messages had been discarded. Please note that the current location is indicated by messages that are MessageDeliveryStatus.INCOMING. If a tag is placed after such message is created and the message only becomes MessageDeliveryStatus.ACCEPTED later, the tag will still follow.

Parameters:

tagLine - Text of the message.

Returns:

The tag message that was recorded.

Throws:

IllegalStateException - When already MessageConsumer.isStopped().

expect

Future<Message> expect(C condition)

Will return a future that will only return when a message arrives that makes the given condition return true.

Parameters:

condition - Condition that needs to be true for the future to unblock.

Returns:

Null if the method unblocked due to some other reason.

expect

Future<Message> expect(C condition,
                       MessageAction<S> action)

Will return a future that will only return when a message arrives that makes the given condition return true, at which point it asynchronously executes a particular action. It will not return until that action has finished executing.

Parameters:

condition - Condition that needs to be true for the future to unblock.

action - Action to execute when the condition becomes true.

Returns:

Null if the method unblocked due to some other reason.