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
FieldsFields 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
ConstructorsModifierConstructorDescriptionprivate
MaxLengthConverter
(List<PatternFormatter> formatters, int maxLength) Construct the converter. -
Method Summary
Modifier and TypeMethodDescriptionvoid
format
(LogEvent event, StringBuilder toAppendTo) Formats an event into a string buffer.static MaxLengthConverter
newInstance
(Configuration config, 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 Details
-
formatters
-
maxLength
private final int maxLength
-
-
Constructor Details
-
MaxLengthConverter
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 Details
-
newInstance
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
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.
-