com.github.benmanes.caffeine.cache.simulator.report

Class TextReporter

java.lang.Object

com.github.benmanes.caffeine.cache.simulator.report.TextReporter

All Implemented Interfaces:

Reporter

Direct Known Subclasses:

CsvReporter, TableReporter

public abstract class TextReporter
extends Object
implements Reporter

A skeletal plain text implementation applicable for printing to the console or a file.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TextReporter(Config config, Set<Policy.Characteristic> characteristics)

Method Summary

Modifier and Type	Method and Description
void	add(PolicyStats policyStats) Adds the result of a policy simulation.
protected abstract String	assemble(List<PolicyStats> results) Assembles an aggregated report.
protected Set<String>	headers() Returns the column headers.
protected Metrics	metrics() Returns the configuration for how to work with metrics.
protected abstract Metrics	newMetrics() Returns a new configuration for how to work with metrics.
void	print() Writes the report to the output destination.
Collection<PolicyStats>	stats() Returns the collected statistics.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextReporter

protected TextReporter(Config config,
                       Set<Policy.Characteristic> characteristics)

Method Detail

add

public void add(PolicyStats policyStats)

Description copied from interface: Reporter

Adds the result of a policy simulation.

Specified by:

add in interface Reporter

print

public void print()
           throws IOException

Description copied from interface: Reporter

Writes the report to the output destination.

Specified by:

print in interface Reporter

Throws:

IOException

stats

public Collection<PolicyStats> stats()

Description copied from interface: Reporter

Returns the collected statistics.

Specified by:

stats in interface Reporter

headers

protected Set<String> headers()

Returns the column headers.

metrics

protected Metrics metrics()

Returns the configuration for how to work with metrics.

newMetrics

protected abstract Metrics newMetrics()

Returns a new configuration for how to work with metrics.

assemble

protected abstract String assemble(List<PolicyStats> results)

Assembles an aggregated report.