org.apache.logging.log4j.message

Enum MapMessage.MapFormat

java.lang.Object

java.lang.Enum<MapMessage.MapFormat>

org.apache.logging.log4j.message.MapMessage.MapFormat

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MapMessage.MapFormat>

Enclosing class:

MapMessage<M extends MapMessage<M,V>,V>

public static enum MapMessage.MapFormat
extends java.lang.Enum<MapMessage.MapFormat>

When set as the format specifier causes the Map to be formatted as XML.

Enum Constant Summary

Enum Constants

Enum Constant and Description
JAVA The map should be formatted the same as documented by AbstractMap.toString().
JAVA_UNQUOTED The map should be formatted the same as documented by AbstractMap.toString() but without quotes.
JSON The map should be formatted as JSON.
XML The map should be formatted as XML.

Method Summary

Modifier and Type	Method and Description
static MapMessage.MapFormat	lookupIgnoreCase(java.lang.String format) Maps a format name to an MapMessage.MapFormat while ignoring case.
static java.lang.String[]	names() All MapFormat names.
static MapMessage.MapFormat	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MapMessage.MapFormat[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

XML

public static final MapMessage.MapFormat XML

The map should be formatted as XML.

JSON

public static final MapMessage.MapFormat JSON

The map should be formatted as JSON.

JAVA

public static final MapMessage.MapFormat JAVA

The map should be formatted the same as documented by AbstractMap.toString().

JAVA_UNQUOTED

public static final MapMessage.MapFormat JAVA_UNQUOTED

The map should be formatted the same as documented by AbstractMap.toString() but without quotes.

Since:

2.11.2

Method Detail

values

public static MapMessage.MapFormat[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MapMessage.MapFormat c : MapMessage.MapFormat.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MapMessage.MapFormat valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

lookupIgnoreCase

public static MapMessage.MapFormat lookupIgnoreCase(java.lang.String format)

Maps a format name to an MapMessage.MapFormat while ignoring case.

Parameters:

format - a MapFormat name

Returns:

a MapFormat

names

public static java.lang.String[] names()

All MapFormat names.

Returns:

All MapFormat names.