Package org.apache.logging.log4j.core.pattern
Provides classes implementing format specifiers in conversion patterns.
-
Interface Summary Interface Description ArrayPatternConverter PatternConverter
s implement this interface to accept an array of objects when formatting.PatternConverter Interface that all PatternConverters must implement.TextRenderer Renders an input to an output. -
Class Summary Class Description AbstractPatternConverter AbstractPatternConverter is an abstract class that provides the formatting functionality that derived classes need.AbstractStyleNameConverter Style pattern converter.AbstractStyleNameConverter.Black Black style pattern converter.AbstractStyleNameConverter.Blue Blue style pattern converter.AbstractStyleNameConverter.Cyan Cyan style pattern converter.AbstractStyleNameConverter.Green Green style pattern converter.AbstractStyleNameConverter.Magenta Magenta style pattern converter.AbstractStyleNameConverter.Red Red style pattern converter.AbstractStyleNameConverter.White White style pattern converter.AbstractStyleNameConverter.Yellow Yellow style pattern converter.ClassNamePatternConverter Formats the class name of the site of the logging request.DatePatternConverter Converts and formats the event's date in a StringBuilder.EncodingPatternConverter Converter that encodes the output from a pattern using a specified format.EndOfBatchPatternConverter Formats the EndOfBatch.EqualsBaseReplacementConverter Equals pattern converter.EqualsIgnoreCaseReplacementConverter Equals ignore case pattern converter.EqualsReplacementConverter Equals pattern converter.ExtendedThrowablePatternConverter Outputs the Throwable portion of the LoggingEvent as a full stack trace unless this converter's option is 'short', where it just outputs the first line of the trace, or if the number of lines to print is explicitly specified.FileDatePatternConverter Formats a date by delegating toDatePatternConverter
.FileLocationPatternConverter Returns the event's line location information in a StringBuilder.FormattingInfo Modifies the output of a pattern converter for a specified minimum and maximum width and alignment.FullLocationPatternConverter Format the event's line location information.HighlightConverter Highlight pattern converter.HtmlTextRenderer TODO Renders an input as HTML output.IntegerPatternConverter Formats an integer.JAnsiTextRenderer Renders an input as ANSI escaped output.LevelPatternConverter Returns the event's level in a StringBuilder.LineLocationPatternConverter Returns the event's line location information in a StringBuilder.LineSeparatorPatternConverter Formats a line separator.LiteralPatternConverter Formats a string literal.LogEventPatternConverter LoggingEventPatternConverter is a base class for pattern converters that can format information from instances of LoggingEvent.LoggerFqcnPatternConverter Formats the Logger FQCN.LoggerPatternConverter Formats a logger name.MapPatternConverter Able to handle the contents of the LogEvent's MapMessage and either output the entire contents of the properties in a similar format to the java.util.Hashtable.toString(), or to output the value of a specific key within the Map.MarkerPatternConverter Returns events' full marker string in a StringBuilder.MarkerSimpleNamePatternConverter Appends an event's maker name to a StringBuilder.MaxLengthConverter Max length pattern converter.MdcPatternConverter Able to handle the contents of the LogEvent's MDC and either output the entire contents of the properties in a similar format to the java.util.Hashtable.toString(), or to output the value of a specific key within the property bundle when this pattern converter has the option set.MessagePatternConverter Returns the event's rendered message in a StringBuilder.MethodLocationPatternConverter Returns the event's line location information in a StringBuilder.NameAbbreviator NameAbbreviator generates abbreviated logger and class names.NamePatternConverter Abstract base class for other pattern converters which can return only parts of their name.NanoTimePatternConverter Converts and formats the event's nanoTime in a StringBuilder.NdcPatternConverter Returns the event's NDC in a StringBuilder.NotANumber PatternFormatter PatternParser Most of the work of thePatternLayout
class is delegated to the PatternParser class.PlainTextRenderer Renders input unchanged.ProcessIdPatternConverter RegexReplacement Replace tokens in the LogEvent message.RegexReplacementConverter Replacement pattern converter.RelativeTimePatternConverter Returns the relative time in milliseconds since JVM Startup.RootThrowablePatternConverter Outputs the Throwable portion of the LoggingEvent as a full stack trace unless this converter's option is 'short', where it just outputs the first line of the trace, or if the number of lines to print is explicitly specified.SequenceNumberPatternConverter Formats the event sequence number.StyleConverter Style pattern converter.ThreadIdPatternConverter Formats the event thread ID.ThreadNamePatternConverter Formats the event thread name.ThreadPriorityPatternConverter Formats the event thread priority.ThrowablePatternConverter Outputs the Throwable portion of the LoggingEvent as a full stack trace unless this converter's option is 'short', where it just outputs the first line of the trace, or if the number of lines to print is explicitly specified.UuidPatternConverter Formats the event sequence number.VariablesNotEmptyReplacementConverter VariablesNotEmpty pattern converter. -
Enum Summary Enum Description AnsiEscape Converts text into ANSI escape sequences. -
Annotation Types Summary Annotation Type Description ConverterKeys Identifies the keys that are associated with a PatternConverter.