com.github.triceo.splitlog.api

Interface MessageMeasure<T extends Number,S extends MessageProducer<S>>

Type Parameters:

T - The value type returned by the metric.

S - Where this is getting its Messages from.

public interface MessageMeasure<T extends Number,S extends MessageProducer<S>>

Used by MessageMetric to determine how much a Message is worth. Users are discouraged from implementing these as stateful - doing so will result in unpredictable behavior, as a single instance of the class can be shared across multiple MessageMetrics.

Method Summary

Methods

Modifier and Type	Method and Description
T	initialValue() The default value for the resulting MessageMetric.
T	update(MessageMetric<T,S> metric, Message evaluate, MessageDeliveryStatus status, S source) Update metric after the arrival of another message.

Method Detail

initialValue

T initialValue()

The default value for the resulting MessageMetric.

Returns:

Whetever value that the metric should start with.

update

T update(MessageMetric<T,S> metric,
       Message evaluate,
       MessageDeliveryStatus status,
       S source)

Update metric after the arrival of another message.

Parameters:

metric - The metric that is being updated.

evaluate - The message to evaluate.

status - Current processing status of the message.

source - The notifying object.

Returns:

The new value for the metric. Message count will be incremented automatically.