org.apache.logging.log4j.core.layout

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 and Description
static class	MarkerPatternSelector.Builder Custom MarkerPatternSelector builder.

Field Summary

Fields inherited from interface org.apache.logging.log4j.core.layout.PatternSelector

ELEMENT_TYPE

Constructor Summary

Constructors

Constructor and Description
MarkerPatternSelector(PatternMatch[] properties, String defaultPattern, boolean alwaysWriteExceptions, boolean noConsoleNoAnsi, Configuration config) Deprecated. Use newBuilder() instead. This will be private in a future version.

Method Summary

Modifier and Type	Method and 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 java.lang.Object

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

Constructor Detail

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.

Method Detail

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 -

defaultPattern -

alwaysWriteExceptions -

noConsoleNoAnsi -

configuration -

Returns:

a new MarkerPatternSelector.

toString

public String toString()

Overrides:

toString in class Object