Class MarkerPatternSelector

java.lang.Object

org.apache.logging.log4j.core.layout.MarkerPatternSelector

All Implemented Interfaces:

LocationAware, PatternSelector

@Plugin(name="MarkerPatternSelector",
        category="Core",
        elementType="patternSelector",
        printObject=true)
public class MarkerPatternSelector
extends Object
implements PatternSelector, LocationAware

Selects the pattern to use based on the Marker in the LogEvent.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MarkerPatternSelector.Builder	Custom MarkerPatternSelector builder.

Field Summary

Fields

Modifier and Type	Field	Description
private final PatternFormatter[]	defaultFormatters
private final String	defaultPattern
private final Map<String, PatternFormatter[]>	formatterMap
private static Logger	LOGGER
private final Map<String,String>	patternMap
private final boolean	requiresLocation

Fields inherited from interface PatternSelector

ELEMENT_TYPE

Constructor Summary

Constructors

Modifier	Constructor	Description
private	MarkerPatternSelector(PatternMatch[] properties, String defaultPattern, boolean alwaysWriteExceptions, boolean disableAnsi, boolean noConsoleNoAnsi, Configuration config)
	MarkerPatternSelector(PatternMatch[] properties, String defaultPattern, boolean alwaysWriteExceptions, boolean noConsoleNoAnsi, Configuration config)	Deprecated. Use newBuilder() instead.

Method Summary

Modifier and Type	Method	Description
static MarkerPatternSelector	createSelector(PatternMatch[] properties, String defaultPattern, boolean alwaysWriteExceptions, boolean noConsoleNoAnsi, Configuration configuration)	Deprecated. Use newBuilder() instead.
PatternFormatter[]	getFormatters(LogEvent event)
static MarkerPatternSelector.Builder	newBuilder()	Creates a builder for a custom ScriptPatternSelector.
boolean	requiresLocation()
String	toString()

Methods inherited from class Object

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

Field Details

formatterMap

private final Map<String, PatternFormatter[]> formatterMap

patternMap

private final Map<String,String> patternMap

defaultFormatters

private final PatternFormatter[] defaultFormatters

defaultPattern

private final String defaultPattern

LOGGER

private static Logger LOGGER

requiresLocation

private final boolean requiresLocation

Constructor Details

MarkerPatternSelector

@Deprecated
public MarkerPatternSelector(PatternMatch[] properties,
 String defaultPattern,
 boolean alwaysWriteExceptions,
 boolean noConsoleNoAnsi,
 Configuration config)

Deprecated.

Use newBuilder() instead. This will be private in a future version.

MarkerPatternSelector

private MarkerPatternSelector(PatternMatch[] properties,
 String defaultPattern,
 boolean alwaysWriteExceptions,
 boolean disableAnsi,
 boolean noConsoleNoAnsi,
 Configuration config)

Method Details

requiresLocation

public boolean requiresLocation()

Specified by:

requiresLocation in interface LocationAware

getFormatters

public PatternFormatter[] getFormatters(LogEvent event)

Specified by:

getFormatters in interface PatternSelector

newBuilder

@PluginBuilderFactory
public static MarkerPatternSelector.Builder newBuilder()

Creates a builder for a custom ScriptPatternSelector.

Returns:

a ScriptPatternSelector builder.

createSelector

@Deprecated
public static MarkerPatternSelector createSelector(PatternMatch[] properties,
 String defaultPattern,
 boolean alwaysWriteExceptions,
 boolean noConsoleNoAnsi,
 Configuration configuration)

Deprecated.

Use newBuilder() instead.

Deprecated, use newBuilder() instead.

Parameters:

properties - PatternMatch configuration items

defaultPattern - the default pattern

alwaysWriteExceptions - To always write exceptions even if the pattern contains no exception conversions.

noConsoleNoAnsi - Do not output ANSI escape codes if System.console() is null.

configuration - the current configuration

Returns:

a new MarkerPatternSelector.

toString

public String toString()

Overrides:

toString in class Object