Class StyleConverter
- java.lang.Object
-
- org.apache.logging.log4j.core.pattern.AbstractPatternConverter
-
- org.apache.logging.log4j.core.pattern.LogEventPatternConverter
-
- org.apache.logging.log4j.core.pattern.StyleConverter
-
- All Implemented Interfaces:
AnsiConverter
,PatternConverter
@Plugin(name="style", category="Converter") public final class StyleConverter extends LogEventPatternConverter implements AnsiConverter
Style pattern converter. Adds ANSI color styling to the result of the enclosed pattern.To disable ANSI output unconditionally, specify an additional option
disableAnsi=true
, or to disable ANSI output if no console is detected, specify optionnoConsoleNoAnsi=true
.
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String
defaultStyle
private boolean
noAnsi
private java.util.List<PatternFormatter>
patternFormatters
private java.lang.String
style
-
Fields inherited from class org.apache.logging.log4j.core.pattern.AbstractPatternConverter
LOGGER
-
Fields inherited from interface org.apache.logging.log4j.core.pattern.PatternConverter
CATEGORY
-
-
Constructor Summary
Constructors Modifier Constructor Description private
StyleConverter(java.util.List<PatternFormatter> patternFormatters, java.lang.String style, boolean noAnsi)
Constructs the converter.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
format(LogEvent event, java.lang.StringBuilder toAppendTo)
Formats an event into a string buffer.boolean
handlesThrowable()
Normally pattern converters are not meant to handle Exceptions although few pattern converters might.static StyleConverter
newInstance(Configuration config, java.lang.String[] options)
Gets an instance of the class.java.lang.String
toString()
Returns a String suitable for debugging.-
Methods inherited from class org.apache.logging.log4j.core.pattern.LogEventPatternConverter
format, isVariable
-
Methods inherited from class org.apache.logging.log4j.core.pattern.AbstractPatternConverter
getName, getStyleClass
-
-
-
-
Field Detail
-
patternFormatters
private final java.util.List<PatternFormatter> patternFormatters
-
noAnsi
private final boolean noAnsi
-
style
private final java.lang.String style
-
defaultStyle
private final java.lang.String defaultStyle
-
-
Constructor Detail
-
StyleConverter
private StyleConverter(java.util.List<PatternFormatter> patternFormatters, java.lang.String style, boolean noAnsi)
Constructs the converter.- Parameters:
patternFormatters
- The PatternFormatters to generate the text to manipulate.style
- The style that should encapsulate the pattern.noAnsi
- If true, do not output ANSI escape codes.
-
-
Method Detail
-
newInstance
public static StyleConverter newInstance(Configuration config, java.lang.String[] options)
Gets an instance of the class.- Parameters:
config
- The current Configuration.options
- pattern options, may be null. If first element is "short", only the first line of the throwable will be formatted.- Returns:
- instance of class.
-
format
public void format(LogEvent event, java.lang.StringBuilder toAppendTo)
Formats an event into a string buffer.- Specified by:
format
in classLogEventPatternConverter
- Parameters:
event
- event to format, may not be null.toAppendTo
- string buffer to which the formatted event will be appended. May not be null.
-
handlesThrowable
public boolean handlesThrowable()
Description copied from class:LogEventPatternConverter
Normally pattern converters are not meant to handle Exceptions although few pattern converters might.By examining the return values for this method, the containing layout will determine whether it handles throwables or not.
- Overrides:
handlesThrowable
in classLogEventPatternConverter
- Returns:
- true if this PatternConverter handles throwables
-
toString
public java.lang.String toString()
Returns a String suitable for debugging.- Overrides:
toString
in classjava.lang.Object
- Returns:
- a String suitable for debugging.
-
-