Interface PatternConverter
-
- All Known Subinterfaces:
ArrayPatternConverter
- All Known Implementing Classes:
AbstractPatternConverter
,AbstractStyleNameConverter
,AbstractStyleNameConverter.Black
,AbstractStyleNameConverter.Blue
,AbstractStyleNameConverter.Cyan
,AbstractStyleNameConverter.Green
,AbstractStyleNameConverter.Magenta
,AbstractStyleNameConverter.Red
,AbstractStyleNameConverter.White
,AbstractStyleNameConverter.Yellow
,ClassNamePatternConverter
,DatePatternConverter
,EncodingPatternConverter
,EqualsBaseReplacementConverter
,EqualsIgnoreCaseReplacementConverter
,EqualsReplacementConverter
,ExtendedThrowablePatternConverter
,FileLocationPatternConverter
,FullLocationPatternConverter
,HighlightConverter
,IntegerPatternConverter
,LevelPatternConverter
,LineLocationPatternConverter
,LineSeparatorPatternConverter
,LiteralPatternConverter
,Log4j1MdcPatternConverter
,Log4j1NdcPatternConverter
,LogEventPatternConverter
,LoggerPatternConverter
,MapPatternConverter
,MarkerPatternConverter
,MarkerSimpleNamePatternConverter
,MaxLengthConverter
,MdcPatternConverter
,MessagePatternConverter
,MethodLocationPatternConverter
,NamePatternConverter
,NanoTimePatternConverter
,NdcPatternConverter
,ProcessIdPatternConverter
,RegexReplacementConverter
,RelativeTimePatternConverter
,RootThrowablePatternConverter
,SequenceNumberPatternConverter
,StyleConverter
,ThreadIdPatternConverter
,ThreadNamePatternConverter
,ThreadPriorityPatternConverter
,ThrowablePatternConverter
,UuidPatternConverter
,VariablesNotEmptyReplacementConverter
public interface PatternConverter
Interface that all PatternConverters must implement.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
CATEGORY
Main plugin category for PatternConverter plugins.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
format(java.lang.Object obj, java.lang.StringBuilder toAppendTo)
Formats an object into a string buffer.java.lang.String
getName()
Returns the name of the converter.java.lang.String
getStyleClass(java.lang.Object e)
This method returns the CSS style class that should be applied to the LoggingEvent passed as parameter, which can be null.
-
-
-
Field Detail
-
CATEGORY
static final java.lang.String CATEGORY
Main plugin category for PatternConverter plugins.- Since:
- 2.1
- See Also:
- Constant Field Values
-
-
Method Detail
-
format
void format(java.lang.Object obj, java.lang.StringBuilder toAppendTo)
Formats an object into a string buffer.- Parameters:
obj
- event to format, may not be null.toAppendTo
- string buffer to which the formatted event will be appended. May not be null.
-
getName
java.lang.String getName()
Returns the name of the converter.- Returns:
- The name of the converter.
-
getStyleClass
java.lang.String getStyleClass(java.lang.Object e)
This method returns the CSS style class that should be applied to the LoggingEvent passed as parameter, which can be null.- Parameters:
e
- null values are accepted- Returns:
- the name of the conversion pattern
-
-