StructuredDataMessage.Format

org.apache.logging.log4j.message

Enum StructuredDataMessage.Format

java.lang.Object
- java.lang.Enum<StructuredDataMessage.Format>
- - org.apache.logging.log4j.message.StructuredDataMessage.Format

All Implemented Interfaces:

Serializable, Comparable<StructuredDataMessage.Format>

Enclosing class:

StructuredDataMessage
```
public static enum StructuredDataMessage.Format
extends Enum<StructuredDataMessage.Format>
```
Supported formats.

Enum Constant Summary

Enum Constants

Enum Constant and Description
`FULL` Full message format includes the type and message.
`XML` The map should be formatted as XML.

Method Summary

Methods

Modifier and Type	Method and Description
`static StructuredDataMessage.Format`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static StructuredDataMessage.Format[]`	`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 StructuredDataMessage.Format XML
```
    The map should be formatted as XML.
  - FULL
```
public static final StructuredDataMessage.Format FULL
```
    Full message format includes the type and message.
- Method Detail
  - values
```
public static StructuredDataMessage.Format[] 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 (StructuredDataMessage.Format c : StructuredDataMessage.Format.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static StructuredDataMessage.Format valueOf(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:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null