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

Class FileLocationPatternConverter

java.lang.Object

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

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

org.apache.logging.log4j.core.pattern.FileLocationPatternConverter

All Implemented Interfaces:

LocationAware, PatternConverter

@Plugin(name="FileLocationPatternConverter",
        category="Converter")
public final class FileLocationPatternConverter
extends LogEventPatternConverter
implements LocationAware

Returns the event's line location information in a StringBuilder.

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

Method Summary

Modifier and Type	Method	Description
void	format(LogEvent event, StringBuilder output)	Formats an event into a string buffer.
static FileLocationPatternConverter	newInstance(String[] options)	Obtains an instance of pattern converter.
boolean	requiresLocation()

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

emptyVariableOutput, format, handlesThrowable, 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

Method Details

newInstance

public static FileLocationPatternConverter newInstance(String[] options)

Obtains an instance of pattern converter.

Parameters:

options - options, may be null.

Returns:

instance of pattern converter.

format

public void format(LogEvent event,
 StringBuilder output)

Formats an event into a string buffer.

Specified by:

format in class LogEventPatternConverter

Parameters:

event - event to format, may not be null.

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

requiresLocation

public boolean requiresLocation()

Specified by:

requiresLocation in interface LocationAware