com.github.triceo.splitlog.api

Interface CommonFollower<P extends MessageProducer<P>,C extends MessageProducer<C>>

All Superinterfaces:

MessageConsumer<C>, MessageListener<C>, MessageProducer<P>

All Known Subinterfaces:

Follower, MergingFollower

public interface CommonFollower<P extends MessageProducer<P>,C extends MessageProducer<C>>
extends MessageProducer<P>, MessageConsumer<C>

Follower's primary function is to allow users to work with their portion of the tailed log file. It provides means for a blocking wait for particular chunks, and can also send these chunks to output. Messages get into the follower when LogWatch notifies it of them. Alternatively, each Follower.tag(String) will create a Message within the follower and not notify anyone.

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.
SortedSet<Message>	getMessages() Retrieve all MessageDeliveryStatus.ACCEPTED messages that this follower has been notified of, and tags.
SortedSet<Message>	getMessages(MessageComparator order) Retrieve all MessageDeliveryStatus.ACCEPTED messages that this follower has been notified of, and tags, in a given order.
SortedSet<Message>	getMessages(SimpleMessageCondition condition) Retrieve all MessageDeliveryStatus.ACCEPTED messages that this follower has been notified of, if a certain condition holds true for them, and tags.
SortedSet<Message>	getMessages(SimpleMessageCondition condition, MessageComparator order) Retrieve all MessageDeliveryStatus.ACCEPTED messages that this follower has been notified of, if a certain condition holds true for them, and tags.
MergingFollower	mergeWith(Follower f) Merge this CommonFollower with another.
MergingFollower	mergeWith(MergingFollower f) Merge this CommonFollower with another.
boolean	write(OutputStream stream) Will write to a stream the result of getMessages(), using a MessageFormatter implementation of its own choosing.
boolean	write(OutputStream stream, MessageComparator order) Will write to a stream the result of getMessages(MessageComparator), using a MessageFormatter implementation of its own choosing.
boolean	write(OutputStream stream, MessageComparator order, MessageFormatter formatter) Will write to a stream the result of getMessages(MessageComparator), using given MessageFormatter.
boolean	write(OutputStream stream, MessageFormatter formatter) Will write to a stream the result of getMessages(), using given MessageFormatter.
boolean	write(OutputStream stream, SimpleMessageCondition condition) Will write to a stream the result of getMessages(SimpleMessageCondition), using a MessageFormatter implementation of its own choosing.
boolean	write(OutputStream stream, SimpleMessageCondition condition, MessageComparator order) Will write to a stream the result of getMessages(SimpleMessageCondition, MessageComparator), using a MessageFormatter implementation of its own choosing.
boolean	write(OutputStream stream, SimpleMessageCondition condition, MessageComparator order, MessageFormatter formatter) Will write to a stream the result of getMessages(SimpleMessageCondition, MessageComparator), using given MessageFormatter.
boolean	write(OutputStream stream, SimpleMessageCondition condition, MessageFormatter formatter) Will write to a stream the result of getMessages(SimpleMessageCondition), using given MessageFormatter.

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

getMessages

SortedSet<Message> getMessages()

Retrieve all MessageDeliveryStatus.ACCEPTED messages that this follower has been notified of, and tags. They will appear in the order in which we have been notified of them.

Returns:

Messages we have been notified of, and tags.

getMessages

SortedSet<Message> getMessages(MessageComparator order)

Retrieve all MessageDeliveryStatus.ACCEPTED messages that this follower has been notified of, and tags, in a given order.

Parameters:

order - The comparator that will be used to order the messages.

Returns:

Messages we have been notified of, and tags.

getMessages

SortedSet<Message> getMessages(SimpleMessageCondition condition)

Retrieve all MessageDeliveryStatus.ACCEPTED messages that this follower has been notified of, if a certain condition holds true for them, and tags. They will be in the order given.

Parameters:

condition - The condition.

Returns:

Messages we have been notified of, for which the condition holds true, and tags.

getMessages

SortedSet<Message> getMessages(SimpleMessageCondition condition,
                               MessageComparator order)

Retrieve all MessageDeliveryStatus.ACCEPTED messages that this follower has been notified of, if a certain condition holds true for them, and tags. They will be in the order in which we have been notified of them.

Parameters:

condition - The condition.

order - The comparator that will be used to order the messages.

Returns:

Messages we have been notified of, for which the condition holds true, and tags.

mergeWith

MergingFollower mergeWith(Follower f)

Merge this CommonFollower with another. This CommonFollower has a responsibility of notifying the resulting MergingFollower of every Message that it receives, until such time that MergingFollower.remove(Follower) is called on it.

Parameters:

f - To merge with.

Returns:

A new MergingFollower, that will merge both CommonFollowers. If any of the CommonFollowers already is a MergingFollower, the returned instance will hold every merged CommonFollower individually and not compose MergingFollowers.

mergeWith

MergingFollower mergeWith(MergingFollower f)

Merge this CommonFollower with another. This CommonFollower has a responsibility of notifying the resulting MergingFollower of every Message that it receives, until such time that MergingFollower.remove(Follower) is called on it.

Parameters:

f - To merge with.

Returns:

A new MergingFollower, that will merge both CommonFollowers. If any of the CommonFollowers already is a MergingFollower, the returned instance will hold every merged CommonFollower individually and not compose MergingFollowers.

write

boolean write(OutputStream stream)

Will write to a stream the result of getMessages(), using a MessageFormatter implementation of its own choosing. Will close the stream.

Parameters:

stream - Target.

Returns:

True if written, false otherwise.

write

boolean write(OutputStream stream,
              MessageComparator order)

Will write to a stream the result of getMessages(MessageComparator), using a MessageFormatter implementation of its own choosing. Will close the stream.

Parameters:

stream - Target.

order - The comparator to pass to getMessages(MessageComparator).

Returns:

True if written, false otherwise.

write

boolean write(OutputStream stream,
              MessageComparator order,
              MessageFormatter formatter)

Will write to a stream the result of getMessages(MessageComparator), using given MessageFormatter. Will close the stream.

Parameters:

stream - Target.

order - The comparator to pass to getMessages(MessageComparator).

formatter - Formatter to use to transform message into string.

Returns:

True if written, false otherwise.

write

boolean write(OutputStream stream,
              MessageFormatter formatter)

Will write to a stream the result of getMessages(), using given MessageFormatter. Will close the stream.

Parameters:

stream - Target.

formatter - Formatter to use to transform message into string.

Returns:

True if written, false otherwise.

write

boolean write(OutputStream stream,
              SimpleMessageCondition condition)

Will write to a stream the result of getMessages(SimpleMessageCondition), using a MessageFormatter implementation of its own choosing. Will close the stream.

Parameters:

stream - Target.

condition - The condition to pass to getMessages(SimpleMessageCondition).

Returns:

True if written, false otherwise.

write

boolean write(OutputStream stream,
              SimpleMessageCondition condition,
              MessageComparator order)

Will write to a stream the result of getMessages(SimpleMessageCondition, MessageComparator), using a MessageFormatter implementation of its own choosing. Will close the stream.

Parameters:

stream - Target.

condition - The condition to pass to getMessages(SimpleMessageCondition, MessageComparator) .

order - The comparator to pass to getMessages(SimpleMessageCondition, MessageComparator) .

Returns:

True if written, false otherwise.

write

boolean write(OutputStream stream,
              SimpleMessageCondition condition,
              MessageComparator order,
              MessageFormatter formatter)

Will write to a stream the result of getMessages(SimpleMessageCondition, MessageComparator), using given MessageFormatter. Will close the stream.

Parameters:

stream - Target.

condition - The condition to pass to getMessages(SimpleMessageCondition, MessageComparator) .

order - The comparator to pass to getMessages(SimpleMessageCondition, MessageComparator) .

formatter - Formatter to use to transform message into string.

Returns:

True if written, false otherwise.

write

boolean write(OutputStream stream,
              SimpleMessageCondition condition,
              MessageFormatter formatter)

Will write to a stream the result of getMessages(SimpleMessageCondition), using given MessageFormatter. Will close the stream.

Parameters:

stream - Target.

condition - The condition to pass to getMessages(SimpleMessageCondition).

formatter - Formatter to use to transform message into string.

Returns:

True if written, false otherwise.

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.