org.tools4j.elara.format

Interface MetricsFormatter

All Superinterfaces:

ValueFormatter<MetricsLogEntry>

public interface MetricsFormatter
extends ValueFormatter<MetricsLogEntry>

Formats value for MessagePrinter when printing lines containing metrics data produced by the MetricsPlugin.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MetricsFormatter.MetricValue
static interface	MetricsFormatter.ValueFormatter

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHOICE Placeholder in format string for choice value available when printing frequency metrics
static MetricsFormatter	DEFAULT
static String	FLAGS Placeholder in format string for metrics flags value
static String	INDEX Placeholder in format string for event index value available when printing time metrics
static String	INTERVAL Placeholder in format string for interval value available when printing frequency metrics
static String	METRICS_COUNT Placeholder in format string for the number of metrics
static String	METRICS_VALUES Placeholder in format string for the metrics values
static String	REPETITION Placeholder in format string for repetition value available when printing frequency metrics
static String	SEQUENCE Placeholder in format string for command sequence value available when printing time metrics
static String	SOURCE Placeholder in format string for command source value available when printing time metrics
static String	TARGET Placeholder in format string for target associated with time metrics
static String	TIME Placeholder in format string for time value
static String	TYPE Placeholder in format string for metrics type value
static String	VERSION Placeholder in format string for metrics descriptor's version value

Fields inherited from interface org.tools4j.elara.format.ValueFormatter

ENTRY_ID, LINE, LINE_SEPARATOR, MESSAGE

Method Summary

Modifier and Type	Method and Description
default Object	choice(long line, long entryId, MetricsLogEntry entry)
default Object	entryId(long line, long entryId, MetricsLogEntry entry)
default Object	flags(long line, long entryId, MetricsLogEntry entry)
default Object	index(long line, long entryId, MetricsLogEntry entry)
default Object	interval(long line, long entryId, MetricsLogEntry entry)
default Object	line(long line, long entryId, MetricsLogEntry entry)
default Object	metricsCount(long line, long entryId, MetricsLogEntry entry)
default Object	metricsValues(long line, long entryId, MetricsLogEntry entry)
default MetricsFormatter.MetricValue	metricValue(long line, long entryId, MetricsLogEntry entry, int index)
default MetricsFormatter.ValueFormatter	metricValueFormatter(long line, long entryId, MetricsLogEntry entry, int index)
default MessagePrinter<MetricsFormatter.MetricValue>	metricValuePrinter(long line, long entryId, MetricsLogEntry entry, int index)
default Object	repetition(long line, long entryId, MetricsLogEntry entry)
default Object	sequence(long line, long entryId, MetricsLogEntry entry)
default Object	source(long line, long entryId, MetricsLogEntry entry)
default Object	target(long line, long entryId, MetricsLogEntry entry)
default Object	time(long line, long entryId, MetricsLogEntry entry)
default Object	type(long line, long entryId, MetricsLogEntry entry)
default Object	value(String placeholder, long line, long entryId, MetricsLogEntry entry)
default Object	version(long line, long entryId, MetricsLogEntry entry)

Field Detail

DEFAULT

static final MetricsFormatter DEFAULT

VERSION

static final String VERSION

Placeholder in format string for metrics descriptor's version value

See Also:

Constant Field Values

FLAGS

static final String FLAGS

Placeholder in format string for metrics flags value

See Also:

Constant Field Values

TYPE

static final String TYPE

Placeholder in format string for metrics type value

See Also:

Constant Field Values

TARGET

static final String TARGET

Placeholder in format string for target associated with time metrics

See Also:

Constant Field Values

SOURCE

static final String SOURCE

Placeholder in format string for command source value available when printing time metrics

See Also:

Constant Field Values

SEQUENCE

static final String SEQUENCE

Placeholder in format string for command sequence value available when printing time metrics

See Also:

Constant Field Values

INDEX

static final String INDEX

Placeholder in format string for event index value available when printing time metrics

See Also:

Constant Field Values

TIME

static final String TIME

Placeholder in format string for time value

See Also:

Constant Field Values

CHOICE

static final String CHOICE

Placeholder in format string for choice value available when printing frequency metrics

See Also:

Constant Field Values

REPETITION

static final String REPETITION

Placeholder in format string for repetition value available when printing frequency metrics

See Also:

Constant Field Values

INTERVAL

static final String INTERVAL

Placeholder in format string for interval value available when printing frequency metrics

See Also:

Constant Field Values

METRICS_COUNT

static final String METRICS_COUNT

Placeholder in format string for the number of metrics

See Also:

Constant Field Values

METRICS_VALUES

static final String METRICS_VALUES

Placeholder in format string for the metrics values

See Also:

Constant Field Values

Method Detail

line

default Object line(long line,
                    long entryId,
                    MetricsLogEntry entry)

entryId

default Object entryId(long line,
                       long entryId,
                       MetricsLogEntry entry)

version

default Object version(long line,
                       long entryId,
                       MetricsLogEntry entry)

flags

default Object flags(long line,
                     long entryId,
                     MetricsLogEntry entry)

type

default Object type(long line,
                    long entryId,
                    MetricsLogEntry entry)

target

default Object target(long line,
                      long entryId,
                      MetricsLogEntry entry)

time

default Object time(long line,
                    long entryId,
                    MetricsLogEntry entry)

source

default Object source(long line,
                      long entryId,
                      MetricsLogEntry entry)

sequence

default Object sequence(long line,
                        long entryId,
                        MetricsLogEntry entry)

index

default Object index(long line,
                     long entryId,
                     MetricsLogEntry entry)

choice

default Object choice(long line,
                      long entryId,
                      MetricsLogEntry entry)

repetition

default Object repetition(long line,
                          long entryId,
                          MetricsLogEntry entry)

interval

default Object interval(long line,
                        long entryId,
                        MetricsLogEntry entry)

metricsCount

default Object metricsCount(long line,
                            long entryId,
                            MetricsLogEntry entry)

metricsValues

default Object metricsValues(long line,
                             long entryId,
                             MetricsLogEntry entry)

value

default Object value(String placeholder,
                     long line,
                     long entryId,
                     MetricsLogEntry entry)

Specified by:

value in interface ValueFormatter<MetricsLogEntry>

metricValuePrinter

default MessagePrinter<MetricsFormatter.MetricValue> metricValuePrinter(long line,
                                                                        long entryId,
                                                                        MetricsLogEntry entry,
                                                                        int index)

metricValueFormatter

default MetricsFormatter.ValueFormatter metricValueFormatter(long line,
                                                             long entryId,
                                                             MetricsLogEntry entry,
                                                             int index)

metricValue

default MetricsFormatter.MetricValue metricValue(long line,
                                                 long entryId,
                                                 MetricsLogEntry entry,
                                                 int index)