MapMessage

java.lang.Object
- org.apache.logging.log4j.message.MapMessage

All Implemented Interfaces:

Serializable, Message, MultiformatMessage

Direct Known Subclasses:

StructuredDataMessage
```
public class MapMessage
extends Object
implements MultiformatMessage
```
Represents a Message that consists of a Map.
Thread-safety note: the contents of this message can be modified after construction. When using asynchronous loggers and appenders it is not recommended to modify this message after the message is logged, because it is undefined whether the logged message string will contain the old values or the modified values.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
`static class`	`MapMessage.MapFormat` When set as the format specifier causes the Map to be formatted as XML.

Constructor Summary

Constructors

Constructor and Description
`MapMessage()` Constructor.
`MapMessage(Map<String,String> map)` Constructor based on an existing Map.

Method Summary

All Methods

Instance Methods

Concrete Methods
Modifier and Type	Method and Description
`protected void`	`appendMap(StringBuilder sb)`
`protected void`	`asJava(StringBuilder sb)`
`protected void`	`asJson(StringBuilder sb)`
`String`	`asString()` Format the Structured data as described in RFC 5424.
`String`	`asString(String format)`
`void`	`asXml(StringBuilder sb)`
`void`	`clear()` Clear the data.
`boolean`	`equals(Object o)`
`String`	`get(String key)` Retrieve the value of the element with the specified key or null if the key is not present.
`Map<String,String>`	`getData()` Returns the message data as an unmodifiable Map.
`String`	`getFormat()` Returns the message.
`String[]`	`getFormats()` Returns the supported formats.
`String`	`getFormattedMessage()` Format the message and return it.
`String`	`getFormattedMessage(String[] formats)` Returns the Message formatted as a String.
`Object[]`	`getParameters()` Returns the data elements as if they were parameters on the logging event.
`Throwable`	`getThrowable()` Always returns null.
`int`	`hashCode()`
`MapMessage`	`newInstance(Map<String,String> map)`
`void`	`put(String key, String value)` Add an item to the data Map.
`void`	`putAll(Map<String,String> map)` Add all the elements from the specified Map.
`String`	`remove(String key)` Remove the element with the specified name.
`String`	`toString()`
`protected void`	`validate(String key, String value)`
`MapMessage`	`with(String key, String value)` Add an item to the data Map in fluent style.

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

- Constructor Detail
  - MapMessage
```
public MapMessage()
```
    Constructor.
  - MapMessage
```
public MapMessage(Map<String,String> map)
```
    Constructor based on an existing Map.
    
    Parameters:
    
    map - The Map.
- Method Detail
  - getFormats
```
public String[] getFormats()
```
    Description copied from interface: MultiformatMessage
    
    Returns the supported formats.
    
    Specified by:
    
    getFormats in interface MultiformatMessage
    
    Returns:
    
    The supported formats.
  - getParameters
```
public Object[] getParameters()
```
    Returns the data elements as if they were parameters on the logging event.
    
    Specified by:
    
    getParameters in interface Message
    
    Returns:
    
    the data elements.
  - getFormat
```
public String getFormat()
```
    Returns the message.
    
    Specified by:
    
    getFormat in interface Message
    
    Returns:
    
    the message.
  - getData
```
public Map<String,String> getData()
```
    Returns the message data as an unmodifiable Map.
    
    Returns:
    
    the message data as an unmodifiable map.
  - clear
```
public void clear()
```
    Clear the data.
  - with
```
public MapMessage with(String key,
                       String value)
```
    Add an item to the data Map in fluent style.
    
    Parameters:
    
    key - The name of the data item.
    
    value - The value of the data item.
    
    Returns:
    
    this
  - put
```
public void put(String key,
                String value)
```
    Add an item to the data Map.
    
    Parameters:
    
    key - The name of the data item.
    
    value - The value of the data item.
  - validate
```
protected void validate(String key,
                        String value)
```
  - putAll
```
public void putAll(Map<String,String> map)
```
    Add all the elements from the specified Map.
    
    Parameters:
    
    map - The Map to add.
  - get
```
public String get(String key)
```
    Retrieve the value of the element with the specified key or null if the key is not present.
    
    Parameters:
    
    key - The name of the element.
    
    Returns:
    
    The value of the element or null if the key is not present.
  - remove
```
public String remove(String key)
```
    Remove the element with the specified name.
    
    Parameters:
    
    key - The name of the element.
    
    Returns:
    
    The previous value of the element.
  - asString
```
public String asString()
```
    Format the Structured data as described in RFC 5424.
    
    Returns:
    
    The formatted String.
  - asString
```
public String asString(String format)
```
  - asXml
```
public void asXml(StringBuilder sb)
```
  - getFormattedMessage
```
public String getFormattedMessage()
```
    Format the message and return it.
    
    Specified by:
    
    getFormattedMessage in interface Message
    
    Returns:
    
    the formatted message.
  - getFormattedMessage
```
public String getFormattedMessage(String[] formats)
```
    Description copied from interface: MultiformatMessage
    
    Returns the Message formatted as a String.
    
    Specified by:
    
    getFormattedMessage in interface MultiformatMessage
    
    Parameters:
    
    formats - An array of Strings that provide extra information about how to format the message. MapMessage uses the first format specifier it recognizes. The supported formats are XML, JSON, and JAVA. The default format is key1="value1" key2="value2" as required by RFC 5424 messages.
    
    Returns:
    
    The formatted message.
  - appendMap
```
protected void appendMap(StringBuilder sb)
```
  - asJson
```
protected void asJson(StringBuilder sb)
```
  - asJava
```
protected void asJava(StringBuilder sb)
```
  - newInstance
```
public MapMessage newInstance(Map<String,String> map)
```
  - toString
```
public String toString()
```
  - equals
```
public boolean equals(Object o)
```
  - hashCode
```
public int hashCode()
```
  - getThrowable
```
public Throwable getThrowable()
```
    Always returns null.
    
    Specified by:
    
    getThrowable in interface Message
    
    Returns:
    
    null

Class MapMessage

Nested Class Summary

Nested Classes

Constructor Summary

Constructors

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MapMessage

MapMessage

Method Detail

getFormats

getParameters

getFormat

getData

clear

with

put

validate

putAll

get

remove

asString

asString

asXml

getFormattedMessage

getFormattedMessage

appendMap

asJson

asJava

newInstance

toString

equals

hashCode

getThrowable