Class PatternParser
java.lang.Object
org.apache.logging.log4j.core.pattern.PatternParser
Most of the work of the
PatternLayout
class is delegated to the
PatternParser class.
It is this class that parses conversion patterns and creates a chained list of PatternConverters
.
-
Constructor Summary
ConstructorsConstructorDescriptionPatternParser
(String converterKey) Constructor.PatternParser
(Configuration config, String converterKey, Class<?> expected) Constructor.PatternParser
(Configuration config, String converterKey, Class<?> expectedClass, Class<?> filterClass) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
parse
(String pattern, List<PatternConverter> patternConverters, List<FormattingInfo> formattingInfos, boolean noConsoleNoAnsi, boolean convertBackslashes) Parse a format specifier.void
parse
(String pattern, List<PatternConverter> patternConverters, List<FormattingInfo> formattingInfos, boolean disableAnsi, boolean noConsoleNoAnsi, boolean convertBackslashes) Parse a format specifier.
-
Constructor Details
-
PatternParser
Constructor.- Parameters:
converterKey
- The type of converters that will be used.
-
PatternParser
Constructor.- Parameters:
config
- The current Configuration ornull
.converterKey
- The key to lookup the converters.expected
- The expected base Class of each Converter ornull
.
-
PatternParser
public PatternParser(Configuration config, String converterKey, Class<?> expectedClass, Class<?> filterClass) Constructor.- Parameters:
config
- The current Configuration ornull
.converterKey
- The key to lookup the converters.expectedClass
- The expected base Class of each Converter ornull
.filterClass
- Filter the returned plugins after calling the plugin manager, can benull
.
-
-
Method Details
-
parse
-
parse
public List<PatternFormatter> parse(String pattern, boolean alwaysWriteExceptions, boolean noConsoleNoAnsi) -
parse
public List<PatternFormatter> parse(String pattern, boolean alwaysWriteExceptions, boolean disableAnsi, boolean noConsoleNoAnsi) -
parse
public void parse(String pattern, List<PatternConverter> patternConverters, List<FormattingInfo> formattingInfos, boolean noConsoleNoAnsi, boolean convertBackslashes) Parse a format specifier.- Parameters:
pattern
- pattern to parse.patternConverters
- list to receive pattern converters.formattingInfos
- list to receive field specifiers corresponding to pattern converters.noConsoleNoAnsi
- do not do not output ANSI escape codes ifSystem.console()
convertBackslashes
- iftrue
, backslash characters are treated as escape characters and character sequences like "\" followed by "t" (backslash+t) are converted to special characters like '\t' (tab).
-
parse
public void parse(String pattern, List<PatternConverter> patternConverters, List<FormattingInfo> formattingInfos, boolean disableAnsi, boolean noConsoleNoAnsi, boolean convertBackslashes) Parse a format specifier.- Parameters:
pattern
- pattern to parse.patternConverters
- list to receive pattern converters.formattingInfos
- list to receive field specifiers corresponding to pattern converters.disableAnsi
- do not output ANSI escape codesnoConsoleNoAnsi
- do not do not output ANSI escape codes ifSystem.console()
convertBackslashes
- iftrue
, backslash characters are treated as escape characters and character sequences like "\" followed by "t" (backslash+t) are converted to special characters like '\t' (tab).
-