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 and 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 and Description
CharacterEscapesJsonFactoryDecorator()

Method Summary

Modifier and Type	Method and Description
void	addEscape(CharacterEscapesJsonFactoryDecorator.Escape escape)
JsonFactory	decorate(JsonFactory factory) Decorates the given JsonFactory.
MappingJsonFactory	decorate(MappingJsonFactory factory) Deprecated.
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 Detail

CharacterEscapesJsonFactoryDecorator

public CharacterEscapesJsonFactoryDecorator()

Method Detail

decorate

@Deprecated
public MappingJsonFactory decorate(MappingJsonFactory factory)

Deprecated.

Description copied from interface: JsonFactoryDecorator

Decorates the given MappingJsonFactory. By default, returns the given factory unchanged.

Specified by:

decorate in interface JsonFactoryDecorator

Returns:

the decorated MappingJsonFactory

decorate

public JsonFactory decorate(JsonFactory factory)

Description copied from interface: JsonFactoryDecorator

Decorates the given JsonFactory. By default, for backwards compatibility purposes, this assumes the given factory is a MappingJsonFactory, and calls JsonFactoryDecorator.decorate(MappingJsonFactory) so that existing implementations that only implemented JsonFactoryDecorator.decorate(MappingJsonFactory) continue to work. In a future release, this will be changed to return the given factory by default, and JsonFactoryDecorator.decorate(MappingJsonFactory) will be removed. It is recommended to only override JsonFactoryDecorator.decorate(JsonFactory). Existing implementations should migrate to only overriding JsonFactoryDecorator.decorate(JsonFactory) so that they will continue to work after JsonFactoryDecorator.decorate(MappingJsonFactory) is removed. 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

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)