Package de.rwth.swc.coffee4j.algorithmic.report

Interface Reporter

All Known Subinterfaces:

GenerationReporter, InterleavingGenerationReporter

All Known Implementing Classes:

EmptyInterleavingGenerationReporter, EmptySequentialGenerationReporter, InterleavingExecutionReporterToGenerationReporterAdapter, SequentialExecutionReporterToGenerationReporterAdapter

public interface Reporter

An interface defining a reporter which can be called by internal algorithms to notify the user of events not covered by an life cycle method in the GenerationReporter. many default methods are just used to give the user a better callable interface and should not be implemented by an extending class.

Method Summary

Modifier and Type	Method	Description
static Reporter	getEmptyReporter()
void	report(ReportLevel level, Report report)	Reports the given Report at the specified level.
void	report(ReportLevel level, Supplier<Report> reportSupplier)	This method has the same intentions as report(ReportLevel, Report), but a supplier is given.
default void	reportAssumptionSatisfaction(String assumptionKey)	Reports a violated assumption that occurred during algorithm execution.
default void	reportAssumptionViolation(String assumptionKey)	Reports a violated assumption that occurred during algorithm execution.
default void	reportDebug(Report report)	Calls report(ReportLevel, Report) with the level ReportLevel.DEBUG and the given report.
default void	reportDebug(Supplier<Report> reportSupplier)	Calls report(ReportLevel, Supplier) with the level ReportLevel.DEBUG and the given supplier.
default void	reportError(Report report)	Calls report(ReportLevel, Report) with the level ReportLevel.ERROR and the given report.
default void	reportError(Supplier<Report> reportSupplier)	Calls report(ReportLevel, Supplier) with the level ReportLevel.ERROR and the given supplier.
default void	reportFatal(Report report)	Calls report(ReportLevel, Report) with the level ReportLevel.FATAL and the given report.
default void	reportFatal(Supplier<Report> reportSupplier)	Calls report(ReportLevel, Supplier) with the level ReportLevel.FATAL and the given supplier.
default void	reportInfo(Report report)	Calls report(ReportLevel, Report) with the level ReportLevel.INFO and the given report.
default void	reportInfo(Supplier<Report> reportSupplier)	Calls report(ReportLevel, Supplier) with the level ReportLevel.INFO and the given supplier.
default void	reportTrace(Report report)	Calls report(ReportLevel, Report) with the level ReportLevel.TRACE and the given report.
default void	reportTrace(Supplier<Report> reportSupplier)	Calls report(ReportLevel, Supplier) with the level ReportLevel.TRACE and the given supplier.
default void	reportWarn(Report report)	Calls report(ReportLevel, Report) with the level ReportLevel.WARN and the given report.
default void	reportWarn(Supplier<Report> reportSupplier)	Calls report(ReportLevel, Supplier) with the level ReportLevel.WARN and the given supplier.

Method Detail

reportTrace

default void reportTrace(Report report)

Calls report(ReportLevel, Report) with the level ReportLevel.TRACE and the given report.

Parameters:

report - what should be reported at level ReportLevel.TRACE

reportTrace

default void reportTrace(Supplier<Report> reportSupplier)

Calls report(ReportLevel, Supplier) with the level ReportLevel.TRACE and the given supplier.

Parameters:

reportSupplier - what should be reported if the reporter listens at level ReportLevel.TRACE

reportDebug

default void reportDebug(Report report)

Calls report(ReportLevel, Report) with the level ReportLevel.DEBUG and the given report.

Parameters:

report - what should be reported at level ReportLevel.DEBUG

reportDebug

default void reportDebug(Supplier<Report> reportSupplier)

Calls report(ReportLevel, Supplier) with the level ReportLevel.DEBUG and the given supplier.

Parameters:

reportSupplier - what should be reported if the reporter listens at level ReportLevel.DEBUG

reportInfo

default void reportInfo(Report report)

Calls report(ReportLevel, Report) with the level ReportLevel.INFO and the given report.

Parameters:

report - what should be reported at level ReportLevel.INFO

reportInfo

default void reportInfo(Supplier<Report> reportSupplier)

Calls report(ReportLevel, Supplier) with the level ReportLevel.INFO and the given supplier.

Parameters:

reportSupplier - what should be reported if the reporter listens at level ReportLevel.INFO

reportWarn

default void reportWarn(Report report)

Calls report(ReportLevel, Report) with the level ReportLevel.WARN and the given report.

Parameters:

report - what should be reported at level ReportLevel.WARN

reportWarn

default void reportWarn(Supplier<Report> reportSupplier)

Calls report(ReportLevel, Supplier) with the level ReportLevel.WARN and the given supplier.

Parameters:

reportSupplier - what should be reported if the reporter listens at level ReportLevel.WARN

reportError

default void reportError(Report report)

Calls report(ReportLevel, Report) with the level ReportLevel.ERROR and the given report.

Parameters:

report - what should be reported at level ReportLevel.ERROR

reportError

default void reportError(Supplier<Report> reportSupplier)

Calls report(ReportLevel, Supplier) with the level ReportLevel.ERROR and the given supplier.

Parameters:

reportSupplier - what should be reported if the reporter listens at level ReportLevel.ERROR

reportFatal

default void reportFatal(Report report)

Calls report(ReportLevel, Report) with the level ReportLevel.FATAL and the given report.

Parameters:

report - what should be reported at level ReportLevel.FATAL

reportFatal

default void reportFatal(Supplier<Report> reportSupplier)

Calls report(ReportLevel, Supplier) with the level ReportLevel.FATAL and the given supplier.

Parameters:

reportSupplier - what should be reported if the reporter listens at level ReportLevel.FATAL

report

void report(ReportLevel level,
            Report report)

Reports the given Report at the specified level. The levels are used so that any Reporter may filter information it wishes to receive.

Parameters:

level - the of the report. Must not be null

report - the report itself. Must not be null

report

void report(ReportLevel level,
            Supplier<Report> reportSupplier)

This method has the same intentions as report(ReportLevel, Report), but a supplier is given. If any big calculations need to be performed for a Report generation this method can be used to guarantee lazy de.rwth.swc.coffee4j.evaluation only if a Reporter is really interested in the report of the given level.

Parameters:

level - the of the report. Must not be null

reportSupplier - a supplier which can compute the real report. It and the returned Report must not be null

reportAssumptionViolation

default void reportAssumptionViolation(String assumptionKey)

Reports a violated assumption that occurred during algorithm execution. Does nothing by default.

Parameters:

assumptionKey - the key for this assumption

reportAssumptionSatisfaction

default void reportAssumptionSatisfaction(String assumptionKey)

Reports a violated assumption that occurred during algorithm execution. Does nothing by default.

Parameters:

assumptionKey - the key for this assumption

getEmptyReporter

static Reporter getEmptyReporter()