Module logstash.logback.encoder

Package net.logstash.logback.decorate

Class CharacterEscapesJsonFactoryDecorator

java.lang.Object

net.logstash.logback.decorate.CharacterEscapesJsonFactoryDecorator

All Implemented Interfaces:

JsonFactoryDecorator

public class CharacterEscapesJsonFactoryDecorator
extends Object
implements JsonFactoryDecorator

A JsonFactoryDecorator that can be used to customize the JsonFactory.setCharacterEscapes(CharacterEscapes). For example, you could change the escape sequence used for newline characters from '\n' to '
'

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CharacterEscapesJsonFactoryDecorator.Escape	Defines how a character will be escaped whenever that character is attempted to be written by a JsonGenerator.

Constructor Summary

Constructors

Constructor	Description
CharacterEscapesJsonFactoryDecorator()

Method Summary

Modifier and Type	Method	Description
void	addEscape(CharacterEscapesJsonFactoryDecorator.Escape escape)
JsonFactory	decorate(JsonFactory factory)	Decorates the given JsonFactory.
boolean	isIncludeStandardAsciiEscapesForJSON()
void	removeEscape(CharacterEscapesJsonFactoryDecorator.Escape escape)
void	setIncludeStandardAsciiEscapesForJSON(boolean includeStandardAsciiEscapesForJSON)

Methods inherited from class java.lang.Object

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

Constructor Details

CharacterEscapesJsonFactoryDecorator

public CharacterEscapesJsonFactoryDecorator()

Method Details

decorate

public JsonFactory decorate(JsonFactory factory)

Description copied from interface: JsonFactoryDecorator

Decorates the given JsonFactory.

By default, returns the given factory unchanged.

Note that the default JsonFactory created by logstash-logback-encoder is a MappingJsonFactory, but can be changed by JsonFactoryDecorators to any subclass of JsonFactory.

Specified by:

decorate in interface JsonFactoryDecorator

Parameters:

factory - the factory to decorate

Returns:

the decorated JsonFactory

isIncludeStandardAsciiEscapesForJSON

public boolean isIncludeStandardAsciiEscapesForJSON()

setIncludeStandardAsciiEscapesForJSON

public void setIncludeStandardAsciiEscapesForJSON(boolean includeStandardAsciiEscapesForJSON)

addEscape

public void addEscape(CharacterEscapesJsonFactoryDecorator.Escape escape)

removeEscape

public void removeEscape(CharacterEscapesJsonFactoryDecorator.Escape escape)