Index (splitlog-api: the public APIs 1.5.0 API)

A C D E F G H I L M S T U V W

A

accept(MessageMetric<T, S>) - Method in interface com.github.triceo.splitlog.api.MessageMetricCondition: Evaluate metric against a user-provided condition.
accept(Message, MessageDeliveryStatus, S) - Method in interface com.github.triceo.splitlog.api.MidDeliveryMessageCondition: Evaluate a message against a user-provided condition.
accept(Message) - Method in interface com.github.triceo.splitlog.api.SimpleMessageCondition: Evaluate a message against a user-provided condition.

C

com.github.triceo.splitlog.api - package com.github.triceo.splitlog.api
CommonFollower,C extends MessageProducer<C>> - Interface in com.github.triceo.splitlog.api: Follower's primary function is to allow users to work with their portion of the tailed log file.
countConsumers() - Method in interface com.github.triceo.splitlog.api.MessageProducer: Return the number of consumers that have been MessageProducer.startConsuming(MessageListener)'d and not MessageProducer.stopConsuming(MessageConsumer)'d.
countMetrics() - Method in interface com.github.triceo.splitlog.api.MessageMetricProducer: Return the number of metrics that have been startMeasuring(MessageMeasure, String)'d and not stopMeasuring(String)'d.

D

determineDate(List<String>) - Method in interface com.github.triceo.splitlog.api.TailSplitter: Read the message and find the date when the message was submitted.
determineException(List<String>) - Method in interface com.github.triceo.splitlog.api.TailSplitter: Read the message and try to identify an exception stack trace within.
determineSeverity(List<String>) - Method in interface com.github.triceo.splitlog.api.TailSplitter: Read the message and try to find its severity.
determineType(List<String>) - Method in interface com.github.triceo.splitlog.api.TailSplitter: Read the message and try to find its type.

E

ExceptionDescriptor - Interface in com.github.triceo.splitlog.api: Describes an exception instance.

F

Follower - Interface in com.github.triceo.splitlog.api: On top of the CommonFollower's functions, this allows for merging followers.
format(Message, File) - Method in interface com.github.triceo.splitlog.api.MessageFormatter: Provides a textual representation of a message.

G

getCause() - Method in interface com.github.triceo.splitlog.api.ExceptionDescriptor: Returns the cause for this exception.
getDate() - Method in interface com.github.triceo.splitlog.api.Message: Get the date that this message was logged on.
getExceptionClass() - Method in interface com.github.triceo.splitlog.api.ExceptionDescriptor: Best-effort attempt to provide an exception type for ExceptionDescriptor.getExceptionClassName().
getExceptionClassName() - Method in interface com.github.triceo.splitlog.api.ExceptionDescriptor
getExceptionDescriptor() - Method in interface com.github.triceo.splitlog.api.Message: Get data about exception included in this message.
getFollowed() - Method in interface com.github.triceo.splitlog.api.Follower: Retrieve the log watch that is being followed.
getLines() - Method in interface com.github.triceo.splitlog.api.Message: Get each line of the message.
getLinesWithoutMetadata() - Method in interface com.github.triceo.splitlog.api.Message: Get each line of the message, with metadata stripped out.
getMeasure() - Method in interface com.github.triceo.splitlog.api.MessageMetric: Retrieves the measure that is used to produce the value of this metric.
getMerged() - Method in interface com.github.triceo.splitlog.api.MergingFollower: Retrieve followers that are currently part of this merge.
getMessage() - Method in interface com.github.triceo.splitlog.api.ExceptionDescriptor
getMessageCount() - Method in interface com.github.triceo.splitlog.api.MessageMetric: Retrieve the number of times that the metric has been invoked on a Message.
getMessageCount(Message) - Method in interface com.github.triceo.splitlog.api.MessageMetric: Retrieve the number of times that the metric has been invoked on a Message, at the time immediately after a given message has been processed.
getMessages() - Method in interface com.github.triceo.splitlog.api.CommonFollower: Retrieve messages that this follower has been notified of, and tags.
getMessages(MessageComparator) - Method in interface com.github.triceo.splitlog.api.CommonFollower: Retrieve messages that this follower has been notified of, and tags, in a given order.
getMessages(SimpleMessageCondition) - Method in interface com.github.triceo.splitlog.api.CommonFollower: Retrieve messages that this follower has been notified of, if a certain condition holds true for them, and tags.
getMessages(SimpleMessageCondition, MessageComparator) - Method in interface com.github.triceo.splitlog.api.CommonFollower: Retrieve messages that this follower has been notified of, if a certain condition holds true for them, and tags.
getMetric(String) - Method in interface com.github.triceo.splitlog.api.MessageMetricProducer: Retrieve the metric for a particular ID.
getMetricId(MessageMetric<? extends Number, P>) - Method in interface com.github.triceo.splitlog.api.MessageMetricProducer: Retrieve the ID for a particular measure.
getPreviousMessage() - Method in interface com.github.triceo.splitlog.api.Message: Return a message that preceded this one in the same log stream.
getSeverity() - Method in interface com.github.triceo.splitlog.api.Message
getSource() - Method in interface com.github.triceo.splitlog.api.MessageMetric: Retrieve the instance that is responsible for notifying this metric of new Messages-
getStackTrace() - Method in interface com.github.triceo.splitlog.api.ExceptionDescriptor: This method will create a brand new unmodifiable list every time it is called.
getType() - Method in interface com.github.triceo.splitlog.api.Message
getUniqueId() - Method in interface com.github.triceo.splitlog.api.Message: Unique ID of the message, that can be used to compare messages in the order of their arrival into this tool.
getValue() - Method in interface com.github.triceo.splitlog.api.MessageMetric: Retrieve the value of this metric, which is a sum of the return values of all of this metric's MessageMeasure invocations.
getValue(Message) - Method in interface com.github.triceo.splitlog.api.MessageMetric: Retrieve the value of this metric, which is a sum of the return values of all of this metric's MessageMeasure invocations, at the time immediately after a given message has been processed.
getWatchedFile() - Method in interface com.github.triceo.splitlog.api.LogWatch: The file that is being tracked by this class.

H

hasException() - Method in interface com.github.triceo.splitlog.api.Message

I

initialValue() - Method in interface com.github.triceo.splitlog.api.MessageMeasure: The default value for the resulting MessageMetric.
isConsuming(MessageConsumer) - Method in interface com.github.triceo.splitlog.api.MessageProducer: Whether or not the particular message consumer is being notified of new messages.
isFollowedBy(Follower) - Method in interface com.github.triceo.splitlog.api.LogWatch: Whether or not LogWatch.stopFollowing(Follower) has been called for a given follower.
isHandingDown(MessageMeasure<? extends Number, Follower>) - Method in interface com.github.triceo.splitlog.api.LogWatch: Whether or not particular MessageMeasure is being automatically handed down to new Followers.
isHandingDown(String) - Method in interface com.github.triceo.splitlog.api.LogWatch: Whether or not particular MessageMeasure is being automatically handed down to new Followers.
isMeasuring(MessageMetric<? extends Number, P>) - Method in interface com.github.triceo.splitlog.api.MessageMetricProducer: Whether or not particular MessageMetric is active.
isMeasuring(String) - Method in interface com.github.triceo.splitlog.api.MessageMetricProducer: Whether or not particular MessageMetric is active.
isRootCause() - Method in interface com.github.triceo.splitlog.api.ExceptionDescriptor
isStartingLine(String) - Method in interface com.github.triceo.splitlog.api.TailSplitter: Whether or not this particular line from the log starts a new log message.
isStopped() - Method in interface com.github.triceo.splitlog.api.MessageConsumer: Whether or not MessageConsumer.stop() has been called.
isTerminated() - Method in interface com.github.triceo.splitlog.api.LogWatch: Whether or not LogWatch.terminate() has been called.

L

LINE_SEPARATOR - Static variable in interface com.github.triceo.splitlog.api.MessageFormatter: Platform-specific line separator.
LogWatch - Interface in com.github.triceo.splitlog.api: The primary point of interaction with this tool.

M

mergeWith(Follower) - Method in interface com.github.triceo.splitlog.api.CommonFollower: Merge this CommonFollower with another.
mergeWith(MergingFollower) - Method in interface com.github.triceo.splitlog.api.CommonFollower: Merge this CommonFollower with another.
MergingFollower - Interface in com.github.triceo.splitlog.api: Follower that is capable of merging multiple Followers.
Message - Interface in com.github.triceo.splitlog.api: A set of lines from the watched file, that is likely to constitute a single log message.
MessageComparator - Interface in com.github.triceo.splitlog.api: Will be used to compare Message instances to determine their order.
MessageConsumer> - Interface in com.github.triceo.splitlog.api: Implementors of this interface state that they are interested in knowing when a new Message appears in the log.
MessageDeliveryStatus - Enum in com.github.triceo.splitlog.api: Various states that a Message can be in while within the system.
MessageFormatter - Interface in com.github.triceo.splitlog.api: Converts a message to a textual representation.
MessageListener> - Interface in com.github.triceo.splitlog.api: Implementors of this interface state that they are interested in knowing when a new Message appears in the log.
MessageMeasure<T extends Number,S extends MessageProducer<S>> - Interface in com.github.triceo.splitlog.api: Used by MessageMetric to determine how much a Message is worth.
MessageMetric<T extends Number,S extends MessageProducer<S>> - Interface in com.github.triceo.splitlog.api: Allows users to track various statistics on classes implementing MessageMetricProducer.
MessageMetricCondition<T extends Number,S extends MessageProducer<S>> - Interface in com.github.triceo.splitlog.api: Allows users to filter based on their own metric criteria.
MessageMetricProducer> - Interface in com.github.triceo.splitlog.api: Implementors of this interface provide users with means of measuring various properties of Messages that pass through them.
MessageProducer> - Interface in com.github.triceo.splitlog.api: Mark classes that are allowed to send message delivery notifications to others.
messageReceived(Message, MessageDeliveryStatus, P) - Method in interface com.github.triceo.splitlog.api.MessageListener: Notify the code of a new message becoming available in the log.
MessageSeverity - Enum in com.github.triceo.splitlog.api: How important the log file says the message is.
MessageType - Enum in com.github.triceo.splitlog.api: Type of message from the log.
MidDeliveryMessageCondition<S extends MessageProducer<S>> - Interface in com.github.triceo.splitlog.api: Allows users to filter messages based on their own criteria.

S

separate(Follower) - Method in interface com.github.triceo.splitlog.api.MergingFollower: Will remove the follower from MergingFollower.getMerged().
SimpleMessageCondition - Interface in com.github.triceo.splitlog.api: Allows users to either accept or reject a message in various situations.
startConsuming(MessageListener) - Method in interface com.github.triceo.splitlog.api.MessageProducer: Register a listener to be notified of new messages in this producer.
startFollowing() - Method in interface com.github.triceo.splitlog.api.LogWatch: Begin watching for new messages from this point in time.
startFollowing(MidDeliveryMessageCondition<LogWatch>) - Method in interface com.github.triceo.splitlog.api.LogWatch: Begin watching for new messages from this point in time, immediately calling CommonFollower.waitFor(MidDeliveryMessageCondition) - this way, no messages can be missed between the actual start of the tailer and the first wait.
startFollowing(MidDeliveryMessageCondition<LogWatch>, long, TimeUnit) - Method in interface com.github.triceo.splitlog.api.LogWatch: Begin watching for new messages from this point in time, immediately calling CommonFollower.waitFor(MidDeliveryMessageCondition, long, TimeUnit) - this way, no messages can be missed between the actual start of the tailer and the first wait.
startHandingDown(MessageMeasure<? extends Number, Follower>, String) - Method in interface com.github.triceo.splitlog.api.LogWatch: Every new Follower from now on will immediately receive a new MessageMetric instance with a given ID that is using the given measure instance.
startMeasuring(MessageMeasure<T, P>, String) - Method in interface com.github.triceo.splitlog.api.MessageMetricProducer: Request that a message property be tracked from now on.
stop() - Method in interface com.github.triceo.splitlog.api.MessageConsumer: This consumer will no longer receive any messages.
stopConsuming(MessageConsumer) - Method in interface com.github.triceo.splitlog.api.MessageProducer: Tell a consumer to no longer listen to new messages in this producer.
stopFollowing(Follower) - Method in interface com.github.triceo.splitlog.api.LogWatch: Stop particular follower from following.
stopHandingDown(MessageMeasure<? extends Number, Follower>) - Method in interface com.github.triceo.splitlog.api.LogWatch: Invalidate LogWatch.startHandingDown(MessageMeasure, String).
stopHandingDown(String) - Method in interface com.github.triceo.splitlog.api.LogWatch: Invalidate LogWatch.startHandingDown(MessageMeasure, String).
stopMeasuring(MessageMetric<? extends Number, P>) - Method in interface com.github.triceo.splitlog.api.MessageMetricProducer: Will stop the metric from being notified of new Messages.
stopMeasuring(String) - Method in interface com.github.triceo.splitlog.api.MessageMetricProducer: Will stop the metric from being notified of new Messages.
stripOfMetadata(String) - Method in interface com.github.triceo.splitlog.api.TailSplitter: Take a line from the log and attempt to strip it of metadata, such as severity, type and date.

T

tag(String) - Method in interface com.github.triceo.splitlog.api.Follower: Mark the current location in the tail by a custom message.
TailSplitter - Interface in com.github.triceo.splitlog.api: The purpose of classes implementing this interface is to interpret the log files.
terminate() - Method in interface com.github.triceo.splitlog.api.LogWatch: Stop all followers from following and free resources.

U

update(MessageMetric<T, S>, Message, MessageDeliveryStatus, S) - Method in interface com.github.triceo.splitlog.api.MessageMeasure: Update metric after the arrival of another message.

V

valueOf(String) - Static method in enum com.github.triceo.splitlog.api.MessageDeliveryStatus: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.github.triceo.splitlog.api.MessageSeverity: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.github.triceo.splitlog.api.MessageType: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.github.triceo.splitlog.api.MessageDeliveryStatus: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.github.triceo.splitlog.api.MessageSeverity: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.github.triceo.splitlog.api.MessageType: Returns an array containing the constants of this enum type, in the order they are declared.

W

waitFor(MidDeliveryMessageCondition<C>) - Method in interface com.github.triceo.splitlog.api.CommonFollower: Will block until a message arrives, for which the condition is true.
waitFor(MidDeliveryMessageCondition<C>, long, TimeUnit) - Method in interface com.github.triceo.splitlog.api.CommonFollower: Will block until a message arrives, for which the condition is true.
waitFor(MessageMetricCondition<T, S>) - Method in interface com.github.triceo.splitlog.api.MessageMetric: Will block until a message arrives, for which the condition is true.
waitFor(MessageMetricCondition<T, S>, long, TimeUnit) - Method in interface com.github.triceo.splitlog.api.MessageMetric: Will block until a message arrives, for which the condition is true.
write(OutputStream) - Method in interface com.github.triceo.splitlog.api.CommonFollower: Will write to a stream the result of CommonFollower.getMessages(), using a MessageFormatter implementation of its own choosing.
write(OutputStream, MessageComparator) - Method in interface com.github.triceo.splitlog.api.CommonFollower: Will write to a stream the result of CommonFollower.getMessages(MessageComparator), using a MessageFormatter implementation of its own choosing.
write(OutputStream, MessageComparator, MessageFormatter) - Method in interface com.github.triceo.splitlog.api.CommonFollower: Will write to a stream the result of CommonFollower.getMessages(MessageComparator), using given MessageFormatter.
write(OutputStream, MessageFormatter) - Method in interface com.github.triceo.splitlog.api.CommonFollower: Will write to a stream the result of CommonFollower.getMessages(), using given MessageFormatter.
write(OutputStream, SimpleMessageCondition) - Method in interface com.github.triceo.splitlog.api.CommonFollower: Will write to a stream the result of CommonFollower.getMessages(SimpleMessageCondition), using a MessageFormatter implementation of its own choosing.
write(OutputStream, SimpleMessageCondition, MessageComparator) - Method in interface com.github.triceo.splitlog.api.CommonFollower: Will write to a stream the result of CommonFollower.getMessages(SimpleMessageCondition, MessageComparator), using a MessageFormatter implementation of its own choosing.
write(OutputStream, SimpleMessageCondition, MessageComparator, MessageFormatter) - Method in interface com.github.triceo.splitlog.api.CommonFollower: Will write to a stream the result of CommonFollower.getMessages(SimpleMessageCondition, MessageComparator), using given MessageFormatter.
write(OutputStream, SimpleMessageCondition, MessageFormatter) - Method in interface com.github.triceo.splitlog.api.CommonFollower: Will write to a stream the result of CommonFollower.getMessages(SimpleMessageCondition), using given MessageFormatter.

A C D E F G H I L M S T U V W