MessagePatternConverter

java.lang.Object
- org.apache.logging.log4j.core.pattern.AbstractPatternConverter
- - org.apache.logging.log4j.core.pattern.LogEventPatternConverter
  - - org.apache.logging.log4j.core.pattern.MessagePatternConverter

All Implemented Interfaces:

PatternConverter

Direct Known Subclasses:

MessagePatternConverter.FormattedMessagePatternConverter, MessagePatternConverter.RenderingPatternConverter, MessagePatternConverter.SimpleMessagePatternConverter
```
@Plugin(name="MessagePatternConverter",
        category="Converter")
public class MessagePatternConverter
extends LogEventPatternConverter
```
Returns the event's rendered message in a StringBuilder.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`private static class`	`MessagePatternConverter.FormattedMessagePatternConverter`
`private static class`	`MessagePatternConverter.RenderingPatternConverter`
`private static class`	`MessagePatternConverter.SimpleMessagePatternConverter`

Field Summary

Fields
Modifier and Type Field Description

private static java.lang.String LOOKUPS

private static java.lang.String NOLOOKUPS
- 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 MessagePatternConverter()

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.
`private static TextRenderer`	`loadMessageRenderer(java.lang.String[] options)`
`static MessagePatternConverter`	`newInstance(Configuration config, java.lang.String[] options)`	Obtains an instance of pattern converter.
`private static java.lang.String[]`	`withoutLookupOptions(java.lang.String[] options)`

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LOOKUPS
```
private static final java.lang.String LOOKUPS
```
    See Also:
    
    Constant Field Values
  - NOLOOKUPS
```
private static final java.lang.String NOLOOKUPS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MessagePatternConverter
```
private MessagePatternConverter()
```
- Method Detail
  - loadMessageRenderer
```
private static TextRenderer loadMessageRenderer(java.lang.String[] options)
```
  - newInstance
```
public static MessagePatternConverter newInstance(Configuration config,
                                                  java.lang.String[] options)
```
    Obtains an instance of pattern converter.
    
    Parameters:
    
    config - The Configuration.
    
    options - options, may be null.
    
    Returns:
    
    instance of pattern converter.
  - withoutLookupOptions
```
private static java.lang.String[] withoutLookupOptions(java.lang.String[] options)
```
  - 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 class LogEventPatternConverter
    
    Parameters:
    
    event - event to format, may not be null.
    
    toAppendTo - string buffer to which the formatted event will be appended. May not be null.