Package org.apache.logging.log4j.core.pattern

Class LiteralPatternConverter

java.lang.Object

org.apache.logging.log4j.core.pattern.AbstractPatternConverter

org.apache.logging.log4j.core.pattern.LogEventPatternConverter

org.apache.logging.log4j.core.pattern.LiteralPatternConverter

All Implemented Interfaces:

ArrayPatternConverter, PatternConverter

public final class LiteralPatternConverter
extends LogEventPatternConverter
implements ArrayPatternConverter

Formats a string literal.

Field Summary

Fields inherited from class org.apache.logging.log4j.core.pattern.AbstractPatternConverter

LOGGER

Fields inherited from interface org.apache.logging.log4j.core.pattern.PatternConverter

CATEGORY

Constructor Summary

Constructors

Constructor	Description
LiteralPatternConverter(Configuration config, String literal, boolean convertBackslashes)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
void	format(Object obj, StringBuilder output)	Formats an object into a string buffer.
void	format(StringBuilder output, Object... objects)	Formats an array of Objects.
void	format(LogEvent event, StringBuilder toAppendTo)	Formats an event into a string buffer.
String	getLiteral()
boolean	isVariable()
String	toString()

Methods inherited from class org.apache.logging.log4j.core.pattern.AbstractPatternConverter

getName, getStyleClass

Methods inherited from class org.apache.logging.log4j.core.pattern.LogEventPatternConverter

handlesThrowable

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.logging.log4j.core.pattern.PatternConverter

getName, getStyleClass

Constructor Detail

LiteralPatternConverter

public LiteralPatternConverter(Configuration config,
                               String literal,
                               boolean convertBackslashes)

Create a new instance.

Parameters:

config - The Configuration.

literal - string literal.

convertBackslashes - if true, backslash characters are treated as escape characters and character sequences like "\" followed by "t" (backslash+t) are converted to special characters like '\t' (tab).

Method Detail

format

public void format(LogEvent event,
                   StringBuilder toAppendTo)

Formats an event into a string buffer.

Specified by:

format in class LogEventPatternConverter

Parameters:

event - event to format, may not be null.

toAppendTo - string buffer to which the formatted event will be appended. May not be null.

format

public void format(Object obj,
                   StringBuilder output)

Formats an object into a string buffer.

Specified by:

format in interface PatternConverter

Overrides:

format in class LogEventPatternConverter

Parameters:

obj - event to format, may not be null.

output - string buffer to which the formatted event will be appended. May not be null.

format

public void format(StringBuilder output,
                   Object... objects)

Formats an array of Objects.

Specified by:

format in interface ArrayPatternConverter

Parameters:

output - The StringBuilder to add the content to.

objects - The Object array.

getLiteral

public String getLiteral()

isVariable

public boolean isVariable()

Overrides:

isVariable in class LogEventPatternConverter

toString

public String toString()

Overrides:

toString in class Object