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

Class ClassNamePatternConverter

java.lang.Object

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

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

org.apache.logging.log4j.core.pattern.NamePatternConverter

org.apache.logging.log4j.core.pattern.ClassNamePatternConverter

All Implemented Interfaces:

LocationAware, PatternConverter

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

Formats the class name of the site of the logging request.

Field Summary

Fields

Modifier and Type	Field	Description
private static java.lang.String	NA

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	ClassNamePatternConverter(java.lang.String[] options)	Private constructor.

Method Summary

Modifier and Type	Method	Description
void	format(LogEvent event, java.lang.StringBuilder toAppendTo)	Format a logging event.
static ClassNamePatternConverter	newInstance(java.lang.String[] options)	Gets an instance of ClassNamePatternConverter.
boolean	requiresLocation()

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

abbreviate

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

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

Field Detail

NA

private static final java.lang.String NA

See Also:

Constant Field Values

Constructor Detail

ClassNamePatternConverter

private ClassNamePatternConverter(java.lang.String[] options)

Private constructor.

Parameters:

options - options, may be null.

Method Detail

newInstance

public static ClassNamePatternConverter newInstance(java.lang.String[] options)

Gets an instance of ClassNamePatternConverter.

Parameters:

options - options, may be null.

Returns:

instance of pattern converter.

format

public void format(LogEvent event,
                   java.lang.StringBuilder toAppendTo)

Format a logging event.

Specified by:

format in class LogEventPatternConverter

Parameters:

event - event to format.

toAppendTo - string buffer to which class name will be appended.

requiresLocation

public boolean requiresLocation()

Specified by:

requiresLocation in interface LocationAware