Class LogReporter.Options.Builder

java.lang.Object

io.jstach.rainbowgum.LogReporter.Options.Builder

Enclosing class:

LogReporter.Options

public static final class LogReporter.Options.Builder
extends Object

Builds LogReporter.Options.

Method Summary

Modifier and Type	Method	Description
LogReporter.Options.Builder	alertFormatter(LogFormatter alertFormatter)	Formatter used to render each alert entry when LogReporter.Section.ALERTS is included.
LogReporter.Options	build()	Builds the options.
LogReporter.Options.Builder	loggerLevels(boolean loggerLevels)	Whether to resolve and print each logger's level, via LogConfig.levelResolver(), next to its name when LogReporter.Section.LOGGERS is included.
LogReporter.Options.Builder	maxAlerts(int maxAlerts)	Maximum number of most recent alerts to print when LogReporter.Section.ALERTS is included.
LogReporter.Options.Builder	section(LogReporter.Section section)	Adds a single section to print, in addition to any already added.
LogReporter.Options.Builder	sections(Set<LogReporter.Section> sections)	Replaces the set of sections to print.

Methods inherited from class Object

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

Method Details

sections

public LogReporter.Options.Builder sections(Set<LogReporter.Section> sections)

Replaces the set of sections to print. An empty set is treated the same as never calling this method at all: the default sections (LogReporter.Section.VERSION, LogReporter.Section.COMPONENTS) are used.

Parameters:

sections - sections to print.

Returns:

this.

section

public LogReporter.Options.Builder section(LogReporter.Section section)

Adds a single section to print, in addition to any already added.

Parameters:

section - section to print.

Returns:

this.

maxAlerts

public LogReporter.Options.Builder maxAlerts(int maxAlerts)

Maximum number of most recent alerts to print when LogReporter.Section.ALERTS is included. Oldest-first entries beyond this count are omitted, not truncated mid list. Default is 5.

Parameters:

maxAlerts - maximum alerts to print, zero or greater.

Returns:

this.

alertFormatter

public LogReporter.Options.Builder alertFormatter(LogFormatter alertFormatter)

Formatter used to render each alert entry when LogReporter.Section.ALERTS is included. Alerts are just LogEvents (see LogAlerts.dump()), so any LogFormatter works here, e.g. one that omits the timestamp for a deterministic report. Default prints [timestamp] LEVEL loggerName - message.

Parameters:

alertFormatter - formatter for a single alert.

Returns:

this.

loggerLevels

public LogReporter.Options.Builder loggerLevels(boolean loggerLevels)

Whether to resolve and print each logger's level, via LogConfig.levelResolver(), next to its name when LogReporter.Section.LOGGERS is included. Default is true.

Parameters:

loggerLevels - false to print just the bare logger names.

Returns:

this.

build

public LogReporter.Options build()

Builds the options. With no sections added the default sections (LogReporter.Section.VERSION, LogReporter.Section.COMPONENTS) are used.

Returns:

options.