Package org.apache.logging.log4j.core.layout

Class LoggerFields

java.lang.Object

org.apache.logging.log4j.core.layout.LoggerFields

@Plugin(name="LoggerFields",
        category="Core",
        printObject=true)
public final class LoggerFields
extends java.lang.Object

A LoggerFields container.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	discardIfAllFieldsAreEmpty
private java.lang.String	enterpriseId
private java.util.Map<java.lang.String,java.lang.String>	map
private java.lang.String	sdId

Constructor Summary

Constructors

Modifier	Constructor	Description
private	LoggerFields(java.util.Map<java.lang.String,java.lang.String> map, java.lang.String sdId, java.lang.String enterpriseId, boolean discardIfAllFieldsAreEmpty)

Method Summary

Modifier and Type	Method	Description
static LoggerFields	createLoggerFields(KeyValuePair[] keyValuePairs, java.lang.String sdId, java.lang.String enterpriseId, boolean discardIfAllFieldsAreEmpty)	Create a LoggerFields from KeyValuePairs.
boolean	getDiscardIfAllFieldsAreEmpty()
java.util.Map<java.lang.String,java.lang.String>	getMap()
StructuredDataId	getSdId()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

map

private final java.util.Map<java.lang.String,java.lang.String> map

sdId

private final java.lang.String sdId

enterpriseId

private final java.lang.String enterpriseId

discardIfAllFieldsAreEmpty

private final boolean discardIfAllFieldsAreEmpty

Constructor Detail

LoggerFields

private LoggerFields(java.util.Map<java.lang.String,java.lang.String> map,
                     java.lang.String sdId,
                     java.lang.String enterpriseId,
                     boolean discardIfAllFieldsAreEmpty)

Method Detail

getMap

public java.util.Map<java.lang.String,java.lang.String> getMap()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

createLoggerFields

@PluginFactory
public static LoggerFields createLoggerFields(@PluginElement("LoggerFields")
                                              KeyValuePair[] keyValuePairs,
                                              @PluginAttribute("sdId")
                                              java.lang.String sdId,
                                              @PluginAttribute("enterpriseId")
                                              java.lang.String enterpriseId,
                                              @PluginAttribute("discardIfAllFieldsAreEmpty")
                                              boolean discardIfAllFieldsAreEmpty)

Create a LoggerFields from KeyValuePairs.

Parameters:

keyValuePairs - An array of KeyValuePairs.

sdId - The SD-ID in an SD-ELEMENT

enterpriseId - The IANA assigned enterprise number

discardIfAllFieldsAreEmpty - this SD-ELEMENT should be discarded if all fields are empty

Returns:

A LoggerFields instance containing a Map<String, String>.

getSdId

public StructuredDataId getSdId()

getDiscardIfAllFieldsAreEmpty

public boolean getDiscardIfAllFieldsAreEmpty()