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

Class VariablesNotEmptyReplacementConverter

java.lang.Object

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

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

org.apache.logging.log4j.core.pattern.VariablesNotEmptyReplacementConverter

All Implemented Interfaces:

PatternConverter

@Plugin(name="notEmpty",
        category="Converter")
public final class VariablesNotEmptyReplacementConverter
extends LogEventPatternConverter

VariablesNotEmpty pattern converter.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final List<PatternFormatter>	formatters

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

Modifier	Constructor	Description
private	VariablesNotEmptyReplacementConverter(List<PatternFormatter> formatters)	Constructs the converter.

Method Summary

Modifier and Type	Method	Description
void	format(LogEvent event, StringBuilder toAppendTo)	Formats an event into a string buffer.
boolean	handlesThrowable()	Tests whether this pattern converter is renders a Throwable.
static VariablesNotEmptyReplacementConverter	newInstance(Configuration config, String[] options)	Gets an instance of the class.
private static boolean	sequenceRegionMatches(CharSequence sequence1, int sequence1Offset, CharSequence sequence2)

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

emptyVariableOutput, format, isVariable

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

getName, getStyleClass

Methods inherited from class java.lang.Object

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

Field Details

formatters

final List<PatternFormatter> formatters

Constructor Details

VariablesNotEmptyReplacementConverter

private VariablesNotEmptyReplacementConverter(List<PatternFormatter> formatters)

Constructs the converter.

Parameters:

formatters - The PatternFormatters to generate the text to manipulate.

Method Details

newInstance

public static VariablesNotEmptyReplacementConverter newInstance(Configuration config,
 String[] options)

Gets an instance of the class.

Parameters:

config - The current Configuration.

options - pattern options, may be null.

Returns:

instance of class.

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.

sequenceRegionMatches

private static boolean sequenceRegionMatches(CharSequence sequence1,
 int sequence1Offset,
 CharSequence sequence2)

Parameters:

sequence1 - the 1st sequence

sequence1Offset - the start index of the 1st sequence region

sequence2 - the 2nd sequence

Returns:

true, if the pointed region of the 1st sequence matches to the 2nd sequence; false, otherwise

handlesThrowable

public boolean handlesThrowable()

Description copied from class: LogEventPatternConverter

Tests whether this pattern converter is renders a Throwable.

The PatternParser checks this flag when processing the alwaysWriteExceptions option: if no converter in the pattern handles throwables, the parser automatically appends a converter to ensure exceptions are still written.

Overrides:

handlesThrowable in class LogEventPatternConverter

Returns:

true if this converter consumes and renders a Throwable, false otherwise