Package org.apache.logging.log4j.message
Class StructuredDataId
java.lang.Object
org.apache.logging.log4j.message.StructuredDataId
- All Implemented Interfaces:
Serializable,StringBuilderFormattable
The StructuredData identifier.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final Stringprivate final intprivate static final intstatic final StructuredDataIdRFC 5424 Meta.private final Stringprivate final String[]static final StructuredDataIdRFC 5424 Origin.private final String[]static final intReserved enterprise number.private static final longstatic final StructuredDataIdRFC 5424 Time Quality. -
Constructor Summary
ConstructorsConstructorDescriptionStructuredDataId(String name) Creates a StructuredDataId based on the name.StructuredDataId(String name, int maxLength) Creates a StructuredDataId based on the name.StructuredDataId(String name, int enterpriseNumber, String[] required, String[] optional) A Constructor that helps conformance to RFC 5424.StructuredDataId(String name, int enterpriseNumber, String[] required, String[] optional, int maxLength) A Constructor that helps conformance to RFC 5424.StructuredDataId(String name, String[] required, String[] optional) StructuredDataId(String name, String[] required, String[] optional, int maxLength) A Constructor that helps conformance to RFC 5424. -
Method Summary
Modifier and TypeMethodDescriptionvoidformatTo(StringBuilder buffer) Writes a text representation of this object into the specifiedStringBuilder, ideally without allocating temporary objects.intReturns the enterprise number.getName()Returns the StructuredDataId name.String[]Returns a list of optional keys.String[]Returns a list of required keys.booleanIndicates if the id is reserved.Creates an id based on the current id.Creates an id using another id to supply default values.toString()
-
Field Details
-
TIME_QUALITY
RFC 5424 Time Quality. -
ORIGIN
RFC 5424 Origin. -
META
RFC 5424 Meta. -
RESERVED
public static final int RESERVEDReserved enterprise number.- See Also:
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
MAX_LENGTH
private static final int MAX_LENGTH- See Also:
-
AT_SIGN
- See Also:
-
name
-
enterpriseNumber
private final int enterpriseNumber -
required
-
optional
-
-
Constructor Details
-
StructuredDataId
Creates a StructuredDataId based on the name.- Parameters:
name- The Structured Data Element name (maximum length is 32)- Since:
- 2.9
-
StructuredDataId
Creates a StructuredDataId based on the name.- Parameters:
name- The Structured Data Element name.maxLength- The maximum length of the name.- Since:
- 2.9
-
StructuredDataId
- Parameters:
name-required-optional-
-
StructuredDataId
A Constructor that helps conformance to RFC 5424.- Parameters:
name- The name portion of the id.required- The list of keys that are required for this id.optional- The list of keys that are optional for this id.- Since:
- 2.9
-
StructuredDataId
A Constructor that helps conformance to RFC 5424.- Parameters:
name- The name portion of the id.enterpriseNumber- The enterprise number.required- The list of keys that are required for this id.optional- The list of keys that are optional for this id.
-
StructuredDataId
public StructuredDataId(String name, int enterpriseNumber, String[] required, String[] optional, int maxLength) A Constructor that helps conformance to RFC 5424.- Parameters:
name- The name portion of the id.enterpriseNumber- The enterprise number.required- The list of keys that are required for this id.optional- The list of keys that are optional for this id.maxLength- The maximum length of the StructuredData Id key.- Since:
- 2.9
-
-
Method Details
-
makeId
Creates an id using another id to supply default values.- Parameters:
id- The original StructuredDataId.- Returns:
- the new StructuredDataId.
-
makeId
Creates an id based on the current id.- Parameters:
defaultId- The default id to use if this StructuredDataId doesn't have a name.anEnterpriseNumber- The enterprise number.- Returns:
- a StructuredDataId.
-
getRequired
Returns a list of required keys.- Returns:
- a List of required keys or null if none have been provided.
-
getOptional
Returns a list of optional keys.- Returns:
- a List of optional keys or null if none have been provided.
-
getName
Returns the StructuredDataId name.- Returns:
- the StructuredDataId name.
-
getEnterpriseNumber
public int getEnterpriseNumber()Returns the enterprise number.- Returns:
- the enterprise number.
-
isReserved
public boolean isReserved()Indicates if the id is reserved.- Returns:
- true if the id uses the reserved enterprise number, false otherwise.
-
toString
-
formatTo
Description copied from interface:StringBuilderFormattableWrites a text representation of this object into the specifiedStringBuilder, ideally without allocating temporary objects.- Specified by:
formatToin interfaceStringBuilderFormattable- Parameters:
buffer- the StringBuilder to write into
-