Package org.apache.logging.log4j.core.layout

Class ScriptPatternSelector

java.lang.Object

org.apache.logging.log4j.core.layout.ScriptPatternSelector

All Implemented Interfaces:

LocationAware, PatternSelector

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

Selects the pattern to use based on the result of executing a Script. The returned value will be used as the "key" to choose between one of the configured patterns. If no key is returned or there is no match the default pattern will be used.

Nested Class Summary

Nested Classes

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

Field Summary

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

ELEMENT_TYPE

Constructor Summary

Constructors

Constructor	Description
ScriptPatternSelector(AbstractScript script, PatternMatch[] properties, String defaultPattern, boolean alwaysWriteExceptions, boolean disableAnsi, boolean noConsoleNoAnsi, Configuration config)	Deprecated. Use newBuilder() instead.

Method Summary

Modifier and Type	Method	Description
static ScriptPatternSelector	createSelector(AbstractScript script, PatternMatch[] properties, String defaultPattern, boolean alwaysWriteExceptions, boolean noConsoleNoAnsi, Configuration configuration)	Deprecated. Use newBuilder() instead.
PatternFormatter[]	getFormatters(LogEvent event)
static ScriptPatternSelector.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 Details

ScriptPatternSelector

@Deprecated
public ScriptPatternSelector(AbstractScript script,
 PatternMatch[] properties,
 String defaultPattern,
 boolean alwaysWriteExceptions,
 boolean disableAnsi,
 boolean noConsoleNoAnsi,
 Configuration config)

Deprecated.

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

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 ScriptPatternSelector.Builder newBuilder()

Creates a builder for a custom ScriptPatternSelector.

Returns:

a ScriptPatternSelector builder.

createSelector

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

Deprecated.

Use newBuilder() instead.

Deprecated, use newBuilder() instead.

Parameters:

script - the script

properties - the 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 configuration

Returns:

a new ScriptPatternSelector

toString

public String toString()

Overrides:

toString in class Object