com.github.triceo.splitlog.api

Interface LogWatch

All Superinterfaces:

MessageProducer<LogWatch>

public interface LogWatch
extends MessageProducer<LogWatch>

The primary point of interaction with this tool. Allows users to start listening to changes in log files.

Method Summary

Modifier and Type	Method and Description
File	getWatchedFile() The file that is being tracked by this class.
boolean	isFollowedBy(Follower follower) Whether or not stopFollowing(Follower) has been called for a given follower.
boolean	isHandingDown(MessageMeasure<? extends Number,Follower> measure) Whether or not particular MessageMeasure is being automatically handed down to new Followers.
boolean	isHandingDown(String id) Whether or not particular MessageMeasure is being automatically handed down to new Followers.
boolean	isStarted() Whether or not start() has been called.
boolean	isStopped() Whether or not stop() has been called.
boolean	start() Start tailing the log file.
Follower	startFollowing() Begin watching for new messages from this point in time.
boolean	startHandingDown(MessageMeasure<? extends Number,Follower> measure, String id) Every new Follower from now on will immediately receive a new MessageMetric instance with a given ID that is using the given measure instance.
boolean	stop() Stop all followers from following and free resources.
boolean	stopFollowing(Follower follower) Stop particular follower from following.
boolean	stopHandingDown(MessageMeasure<? extends Number,Follower> measure) Invalidate startHandingDown(MessageMeasure, String).
boolean	stopHandingDown(String id) Invalidate startHandingDown(MessageMeasure, String).

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

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

Method Detail

getWatchedFile

File getWatchedFile()

The file that is being tracked by this class.

Returns:

Never null

isFollowedBy

boolean isFollowedBy(Follower follower)

Whether or not stopFollowing(Follower) has been called for a given follower.

Parameters:

follower - Tailer in question.

Returns:

True if it has.

isHandingDown

boolean isHandingDown(MessageMeasure<? extends Number,Follower> measure)

Whether or not particular MessageMeasure is being automatically handed down to new Followers.

Parameters:

measure - Measure in question.

Returns:

True after startHandingDown(MessageMeasure, String) has been called and before stopHandingDown(MessageMeasure).

isHandingDown

boolean isHandingDown(String id)

Whether or not particular MessageMeasure is being automatically handed down to new Followers.

Parameters:

id - ID in question.

Returns:

True after startHandingDown(MessageMeasure, String) has been called and before stopHandingDown(String).

isStarted

boolean isStarted()

Whether or not start() has been called.

Returns:

True if it has.

isStopped

boolean isStopped()

Whether or not stop() has been called.

Returns:

True if it has.

start

boolean start()

Start tailing the log file.

Returns:

True if just started, false if already started.

startFollowing

Follower startFollowing()

Begin watching for new messages from this point in time.

Returns:

API for watching for messages.

startHandingDown

boolean startHandingDown(MessageMeasure<? extends Number,Follower> measure,
                         String id)

Every new Follower from now on will immediately receive a new MessageMetric instance with a given ID that is using the given measure instance.

Parameters:

measure - Measure to use in the newly created MessageMetric instance.

id - The ID to locate the MessageMetric using MessageProducer.getMetric(String). No relation to the ID used by MessageProducer.startMeasuring(MessageMeasure, String).

Returns:

False if either the measure or the ID is already being handed down.

stop

boolean stop()

Stop all followers from following and free resources. Will terminate every running measurement via MessageMetric.

Returns:

True if terminated as a result, false if already terminated.

stopFollowing

boolean stopFollowing(Follower follower)

Stop particular follower from following.

Parameters:

follower - This follower will receive no more messages.

Returns:

True if terminated as a result, false if already terminated.

stopHandingDown

boolean stopHandingDown(MessageMeasure<? extends Number,Follower> measure)

Invalidate startHandingDown(MessageMeasure, String). No further Follower will automatically receive MessageMetric using this measure by default.

Parameters:

measure - The measure to no longer be handing down to newly instantiated Followers.

Returns:

False if it wasn't being handed down.

stopHandingDown

boolean stopHandingDown(String id)

Invalidate startHandingDown(MessageMeasure, String). No further Follower will automatically receive MessageMetric using this measure by default.

Parameters:

id - The ID of the MessageMeasure to no longer be handing down to newly instantiated Followers. No relation to the ID used by MessageProducer.startMeasuring(MessageMeasure, String) .

Returns:

False if it wasn't being handed down.