Package org.jboss.logmanager.formatters

Class JsonFormatter

java.lang.Object

java.util.logging.Formatter

org.jboss.logmanager.ExtFormatter

org.jboss.logmanager.formatters.StructuredFormatter

org.jboss.logmanager.formatters.JsonFormatter

public class JsonFormatter
extends StructuredFormatter

A formatter that outputs the record into JSON format optionally printing details.

Note that including details can be expensive in terms of calculating the caller.

The details include;

• source class name
• source file name
• source method name
• source line number
• source module name
• source module version

Author:

James R. Perkins

Nested Class Summary

Nested classes/interfaces inherited from class org.jboss.logmanager.formatters.StructuredFormatter

StructuredFormatter.ExceptionOutputType, StructuredFormatter.Generator, StructuredFormatter.Key

Constructor Summary

Constructors

Constructor	Description
JsonFormatter()	Creates a new JSON formatter.
JsonFormatter(String keyOverrides)	Creates a new JSON formatter.
JsonFormatter(Map<StructuredFormatter.Key,String> keyOverrides)	Creates a new JSON formatter.

Method Summary

Modifier and Type	Method	Description
protected StructuredFormatter.Generator	createGenerator(Writer writer)	Creates the generator used to create the structured data.
boolean	isPrettyPrint()	Indicates whether or not pretty printing is enabled.
void	setPrettyPrint(boolean prettyPrint)	Turns on or off pretty printing.

Methods inherited from class org.jboss.logmanager.formatters.StructuredFormatter

after, before, format, getDateTimeFormatter, getExceptionOutputType, getKey, getKeyOverrides, getRecordDelimiter, getZoneId, isCallerCalculationRequired, isDetailedExceptionOutputType, isFormattedExceptionOutputType, isPrintDetails, setDateFormat, setExceptionOutputType, setPrintDetails, setRecordDelimiter, setZoneId

Methods inherited from class org.jboss.logmanager.ExtFormatter

format, formatMessage, formatMessageLegacy, formatMessageNone, formatMessagePrintf

Methods inherited from class java.util.logging.Formatter

getHead, getTail

Methods inherited from class java.lang.Object

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

Constructor Details

JsonFormatter

public JsonFormatter()

Creates a new JSON formatter.

JsonFormatter

public JsonFormatter(String keyOverrides)

Creates a new JSON formatter.

Parameters:

keyOverrides - a string representation of a map to override keys

See Also:

• PropertyValues.stringToEnumMap(Class, String)

JsonFormatter

public JsonFormatter(Map<StructuredFormatter.Key,String> keyOverrides)

Creates a new JSON formatter.

Parameters:

keyOverrides - a map of overrides for the default keys

Method Details

isPrettyPrint

public boolean isPrettyPrint()

Indicates whether or not pretty printing is enabled.

Returns:

true if pretty printing is enabled, otherwise false

setPrettyPrint

public void setPrettyPrint(boolean prettyPrint)

Turns on or off pretty printing.

Parameters:

prettyPrint - true to turn on pretty printing or false to turn it off

createGenerator

protected StructuredFormatter.Generator createGenerator(Writer writer)

Description copied from class: StructuredFormatter

Creates the generator used to create the structured data.

Specified by:

createGenerator in class StructuredFormatter

Returns:

the generator to use