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

Class EqualsBaseReplacementConverter

java.lang.Object

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

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

org.apache.logging.log4j.core.pattern.EqualsBaseReplacementConverter

All Implemented Interfaces:

PatternConverter

Direct Known Subclasses:

EqualsIgnoreCaseReplacementConverter, EqualsReplacementConverter

public abstract class EqualsBaseReplacementConverter
extends LogEventPatternConverter

Equals pattern converter.

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

Modifier	Constructor	Description
protected	EqualsBaseReplacementConverter(String name, String style, List<PatternFormatter> formatters, String testString, String substitution, PatternParser parser)	Construct the converter.

Method Summary

Modifier and Type	Method	Description
protected abstract boolean	equals(String str, StringBuilder buff, int from, int len)	Returns true if the specified String equals the specified section of the specified StringBuilder.
void	format(LogEvent event, StringBuilder toAppendTo)	Formats an event into a string buffer.
boolean	handlesThrowable()	Tests whether this pattern converter is renders a Throwable.

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

Constructor Details

EqualsBaseReplacementConverter

protected EqualsBaseReplacementConverter(String name,
 String style,
 List<PatternFormatter> formatters,
 String testString,
 String substitution,
 PatternParser parser)

Construct the converter.

Parameters:

name - converter name

style - converter style

formatters - The PatternFormatters to generate the text to manipulate.

testString - The test string.

substitution - The substitution string.

parser - The PatternParser.

Method Details

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.

equals

protected abstract boolean equals(String str,
 StringBuilder buff,
 int from,
 int len)

Returns true if the specified String equals the specified section of the specified StringBuilder.

Parameters:

str - the String to compare

buff - the StringBuilder to compare a section of

from - start index in the StringBuilder

len - length of the section in the StringBuilder

Returns:

true if equal, 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