Interface LogFormatter

java.lang.Object
io.github.qishr.cascara.common.diagnostic.format.LogFormatter

All Known Implementing Classes:
PlainLogFormatter

public interface LogFormatter

Formats diagnostic instances into string representations.

Method Summary

Modifier and Type	Method	Description
public abstract String	format(Diagnostic diagnostic)	Formats the given diagnostic into a output line.
public abstract LogFormatter	withFields(Set<Field> fields)	Configures active fields shown in output.
public abstract String	formatStackTrace(Level level, StackTraceElement[] stackTrace, Throwable t)
public abstract LogFormatter	setOptions(FormatOptions formatOptions)

public abstract String format(Diagnostic diagnostic)

Formats the given diagnostic into a output line.

Parameters:

diagnostic - the diagnostic to format

Returns:

formatted string line

Since:

cascara.common-1.0.0

public abstract LogFormatter withFields(Set<Field> fields)

Configures active fields shown in output.

Parameters:

fields - active fields to include

Returns:

this formatter instance

Since:

cascara.common-1.0.0

public abstract String formatStackTrace(Level level, StackTraceElement[] stackTrace, Throwable t)

public abstract LogFormatter setOptions(FormatOptions formatOptions)