Class PatternParser


  • public final class PatternParser
    extends Object
    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 Detail

      • PatternParser

        public PatternParser​(String converterKey)
        Constructor.
        Parameters:
        converterKey - The type of converters that will be used.
      • PatternParser

        public PatternParser​(Configuration config,
                             String converterKey,
                             Class<?> expected)
        Constructor.
        Parameters:
        config - The current Configuration.
        converterKey - The key to lookup the converters.
        expected - The expected base Class of each Converter.
      • PatternParser

        public PatternParser​(Configuration config,
                             String converterKey,
                             Class<?> expectedClass,
                             Class<?> filterClass)
        Constructor.
        Parameters:
        config - The current Configuration.
        converterKey - The key to lookup the converters.
        expectedClass - The expected base Class of each Converter.
        filterClass - Filter the returned plugins after calling the plugin manager.
    • Method Detail

      • 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 if System.console()
        convertBackslashes - if true, 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 codes
        noConsoleNoAnsi - do not do not output ANSI escape codes if System.console()
        convertBackslashes - if true, backslash characters are treated as escape characters and character sequences like "\" followed by "t" (backslash+t) are converted to special characters like '\t' (tab).