Class MaxLengthConverter
- java.lang.Object
-
- org.apache.logging.log4j.core.pattern.AbstractPatternConverter
-
- org.apache.logging.log4j.core.pattern.LogEventPatternConverter
-
- org.apache.logging.log4j.core.pattern.MaxLengthConverter
-
- All Implemented Interfaces:
PatternConverter
@Plugin(name="maxLength", category="Converter") public final class MaxLengthConverter extends LogEventPatternConverter
Max length pattern converter. Limit contained text to a maximum length. On invalid length the default value 100 is used (and an error message is logged). If max length is greater than 20, an abbreviated text will get ellipsis ("...") appended. Example usage (for email subject):"%maxLen{[AppName, ${hostName}, ${web:contextPath}] %p: %c{1} - %m%notEmpty{ =>%ex{short}}}{160}"
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.List<PatternFormatter>
formatters
private int
maxLength
-
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
MaxLengthConverter(java.util.List<PatternFormatter> formatters, int maxLength)
Construct 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.static MaxLengthConverter
newInstance(Configuration config, java.lang.String[] options)
Gets an instance of the class.-
Methods inherited from class org.apache.logging.log4j.core.pattern.LogEventPatternConverter
format, handlesThrowable, isVariable
-
Methods inherited from class org.apache.logging.log4j.core.pattern.AbstractPatternConverter
getName, getStyleClass
-
-
-
-
Field Detail
-
formatters
private final java.util.List<PatternFormatter> formatters
-
maxLength
private final int maxLength
-
-
Constructor Detail
-
MaxLengthConverter
private MaxLengthConverter(java.util.List<PatternFormatter> formatters, int maxLength)
Construct the converter.- Parameters:
formatters
- The PatternFormatters to generate the text to manipulate.maxLength
- The max. length of the resulting string. Ellipsis ("...") is appended on shorted string, if greater than 20.
-
-
Method Detail
-
newInstance
public static MaxLengthConverter newInstance(Configuration config, java.lang.String[] options)
Gets an instance of the class.- Parameters:
config
- The current Configuration.options
- pattern options, an array of two elements: pattern, max length (defaults to 100 on invalid value).- Returns:
- instance of class.
-
format
public void format(LogEvent event, java.lang.StringBuilder toAppendTo)
Description copied from class:LogEventPatternConverter
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.
-
-