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 Object

A LoggerFields container.

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

getMap

public Map<String,String> getMap()

toString

public String toString()

Overrides:

toString in class Object

createLoggerFields

@PluginFactory
public static LoggerFields createLoggerFields(@PluginElement(value="LoggerFields")
                                                             KeyValuePair[] keyValuePairs,
                                                             @PluginAttribute(value="sdId")
                                                             String sdId,
                                                             @PluginAttribute(value="enterpriseId")
                                                             String enterpriseId,
                                                             @PluginAttribute(value="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()