Apache Log4j API 2.22.0 · org.apache.logging.log4j.message.StructuredDataId

Modifier and Type	Field and Description
private static final String	AT_SIGN
private final String	enterpriseNumber
private static final int	MAX_LENGTH
public static final StructuredDataId	META RFC 5424 Meta.
private final String	name
private final String[]	optional
public static final StructuredDataId	ORIGIN RFC 5424 Origin.
private final String[]	required
public static final String	RESERVED Reserved enterprise number.
private static final long	serialVersionUID
public static final StructuredDataId	TIME_QUALITY RFC 5424 Time Quality.

Constructor Summary

Access	Constructor and Description
public	StructuredDataId(final String The Structured Data Element name (maximum length is 32) name) Creates a StructuredDataId based on the name.
public	StructuredDataId(final String The Structured Data Element name. name, final int The maximum length of the name. maxLength) Creates a StructuredDataId based on the name.
public	StructuredDataId(final String The name portion of the id. name, final String[] The list of keys that are required for this id. required, final String[] The list of keys that are optional for this id. optional)
public	StructuredDataId(final String The name portion of the id. name, final String[] The list of keys that are required for this id. required, final String[] The list of keys that are optional for this id. optional, int The maximum length of the id's name. maxLength) A Constructor that helps conformance to RFC 5424.
public	StructuredDataId(final String The name portion of the id. name, final String The enterprise number. enterpriseNumber, final String[] The list of keys that are required for this id. required, final String[] The list of keys that are optional for this id. optional) A Constructor that helps conformance to RFC 5424.
public	StructuredDataId(final String The name portion of the id. name, final int The enterprise number. enterpriseNumber, final String[] The list of keys that are required for this id. required, final String[] The list of keys that are optional for this id. optional) Deprecated Use `StructuredDataId(String, String, String[], String[])` instead. A Constructor that helps conformance to RFC 5424.
public	StructuredDataId(final String The name portion of the id. name, final String The enterprise number. enterpriseNumber, final String[] The list of keys that are required for this id. required, final String[] The list of keys that are optional for this id. optional, final int The maximum length of the StructuredData Id key. maxLength) A Constructor that helps conformance to RFC 5424.
public	StructuredDataId(final String The name portion of the id. name, final int The enterprise number. enterpriseNumber, final String[] The list of keys that are required for this id. required, final String[] The list of keys that are optional for this id. optional, final int The maximum length of the StructuredData Id key. maxLength) Deprecated Use `StructuredDataId(String, String, String[], String[], int)` instead. A Constructor that helps conformance to RFC 5424.

Method Summary

Modifier and Type	Method and Description
public void	formatTo(final StringBuilder the StringBuilder to write into buffer) Implements org.apache.logging.log4j.util.StringBuilderFormattable.formatTo. Writes a text representation of this object into the specified `StringBuilder`, ideally without allocating temporary objects.
public String	Returns: the enterprise number. getEnterpriseNumber() Returns the enterprise number.
public String	Returns: the StructuredDataId name. getName() Returns the StructuredDataId name.
public String[]	Returns: a List of optional keys or null if none have been provided. getOptional() Returns a list of optional keys.
public String[]	Returns: a List of required keys or null if none have been provided. getRequired() Returns a list of required keys.
public boolean	Returns: true if the id uses the reserved enterprise number, false otherwise. isReserved() Indicates if the id is reserved.
public StructuredDataId	Returns: the new StructuredDataId. makeId(final StructuredDataId The original StructuredDataId. id) Creates an id using another id to supply default values.
public StructuredDataId	Returns: a StructuredDataId. makeId(final String The default id to use if this StructuredDataId doesn't have a name. defaultId, final String The enterprise number. anEnterpriseNumber) Creates an id based on the current id.
public final StructuredDataId	Returns: a StructuredDataId. makeId(final String The default id to use if this StructuredDataId doesn't have a name. defaultId, final int The enterprise number. anEnterpriseNumber) Deprecated Use `StructuredDataId#makeId(String, String)` instead Creates an id based on the current id.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

AT_SIGN	back to summary
private static final String AT_SIGN

enterpriseNumber	back to summary
private final String enterpriseNumber

MAX_LENGTH	back to summary
private static final int MAX_LENGTH

META	back to summary
public static final StructuredDataId META RFC 5424 Meta.

name	back to summary
private final String name

optional	back to summary
private final String[] optional

ORIGIN	back to summary
public static final StructuredDataId ORIGIN RFC 5424 Origin.

required	back to summary
private final String[] required

RESERVED	back to summary
public static final String RESERVED Reserved enterprise number.

serialVersionUID	back to summary
private static final long serialVersionUID

TIME_QUALITY	back to summary
public static final StructuredDataId TIME_QUALITY RFC 5424 Time Quality.

Constructor Detail

StructuredDataId	back to summary
public StructuredDataId(final String name) Creates a StructuredDataId based on the name. Parameters name:String The Structured Data Element name (maximum length is 32) Since 2.9

StructuredDataId

back to summary

public StructuredDataId(final String name)

Creates a StructuredDataId based on the name.

Parameters

name:String: The Structured Data Element name (maximum length is 32)

Since

2.9

StructuredDataId	back to summary
public StructuredDataId(final String name, final int maxLength) Creates a StructuredDataId based on the name. Parameters name:String The Structured Data Element name. maxLength:int The maximum length of the name. Since 2.9

StructuredDataId

back to summary

public StructuredDataId(final String name, final int maxLength)

Creates a StructuredDataId based on the name.

Parameters

name:String: The Structured Data Element name.
maxLength:int: The maximum length of the name.

Since

2.9

StructuredDataId	back to summary
public StructuredDataId(final String name, final String[] required, final String[] optional) Parameters name:String The name portion of the id. required:String[] The list of keys that are required for this id. optional:String[] The list of keys that are optional for this id.

StructuredDataId	back to summary
public StructuredDataId(final String name, final String[] required, final String[] optional, int maxLength) A Constructor that helps conformance to RFC 5424. Parameters name:String The name portion of the id. required:String[] The list of keys that are required for this id. optional:String[] The list of keys that are optional for this id. maxLength:int The maximum length of the id's name. Since 2.9

StructuredDataId

back to summary

public StructuredDataId(final String name, final String[] required, final String[] optional, int maxLength)

A Constructor that helps conformance to RFC 5424.

Parameters

name:String: The name portion of the id.
required:String[]: The list of keys that are required for this id.
optional:String[]: The list of keys that are optional for this id.
maxLength:int: The maximum length of the id's name.

Since

2.9

StructuredDataId	back to summary
public StructuredDataId(final String name, final String enterpriseNumber, final String[] required, final String[] optional) A Constructor that helps conformance to RFC 5424. Parameters name:String The name portion of the id. enterpriseNumber:String The enterprise number. required:String[] The list of keys that are required for this id. optional:String[] The list of keys that are optional for this id.

StructuredDataId

back to summary

public StructuredDataId(final String name, final String enterpriseNumber, final String[] required, final String[] optional)

A Constructor that helps conformance to RFC 5424.

Parameters

name:String: The name portion of the id.
enterpriseNumber:String: The enterprise number.
required:String[]: The list of keys that are required for this id.
optional:String[]: The list of keys that are optional for this id.

StructuredDataId back to summary

StructuredDataId	back to summary
public StructuredDataId(final String name, final int enterpriseNumber, final String[] required, final String[] optional) Deprecated Use `StructuredDataId(String, String, String[], String[])` instead. A Constructor that helps conformance to RFC 5424. Parameters name:String The name portion of the id. enterpriseNumber:int The enterprise number. required:String[] The list of keys that are required for this id. optional:String[] The list of keys that are optional for this id. Annotations @Deprecated @InlineMe replacement:this(name, String.valueOf(enterpriseNumber), required, optional)

public StructuredDataId(final String name, final int enterpriseNumber, final String[] required, final String[] optional)

Deprecated

Use StructuredDataId(String, String, String[], String[]) instead.

A Constructor that helps conformance to RFC 5424.

Parameters

name:String: The name portion of the id.
enterpriseNumber:int: The enterprise number.
required:String[]: The list of keys that are required for this id.
optional:String[]: The list of keys that are optional for this id.

Annotations

@Deprecated
@InlineMe
replacement:this(name, String.valueOf(enterpriseNumber), required, optional)

StructuredDataId	back to summary
public StructuredDataId(final String name, final String enterpriseNumber, final String[] required, final String[] optional, final int maxLength) A Constructor that helps conformance to RFC 5424. Parameters name:String The name portion of the id. enterpriseNumber:String The enterprise number. required:String[] The list of keys that are required for this id. optional:String[] The list of keys that are optional for this id. maxLength:int The maximum length of the StructuredData Id key. Since 2.9

StructuredDataId

back to summary

public StructuredDataId(final String name, final String enterpriseNumber, final String[] required, final String[] optional, final int maxLength)

A Constructor that helps conformance to RFC 5424.

Parameters

name:String: The name portion of the id.
enterpriseNumber:String: The enterprise number.
required:String[]: The list of keys that are required for this id.
optional:String[]: The list of keys that are optional for this id.
maxLength:int: The maximum length of the StructuredData Id key.

Since

2.9

StructuredDataId back to summary

StructuredDataId	back to summary
public StructuredDataId(final String name, final int enterpriseNumber, final String[] required, final String[] optional, final int maxLength) Deprecated Use `StructuredDataId(String, String, String[], String[], int)` instead. A Constructor that helps conformance to RFC 5424. Parameters name:String The name portion of the id. enterpriseNumber:int The enterprise number. required:String[] The list of keys that are required for this id. optional:String[] The list of keys that are optional for this id. maxLength:int The maximum length of the StructuredData Id key. Annotations @InlineMe replacement:this(name, String.valueOf(enterpriseNumber), required, optional, maxLength) @Deprecated Since 2.9

public StructuredDataId(final String name, final int enterpriseNumber, final String[] required, final String[] optional, final int maxLength)

Deprecated

Use StructuredDataId(String, String, String[], String[], int) instead.

A Constructor that helps conformance to RFC 5424.

Parameters

name:String: The name portion of the id.
enterpriseNumber:int: The enterprise number.
required:String[]: The list of keys that are required for this id.
optional:String[]: The list of keys that are optional for this id.
maxLength:int: The maximum length of the StructuredData Id key.

Annotations

@InlineMe
replacement:this(name, String.valueOf(enterpriseNumber), required, optional, maxLength)
@Deprecated

Since

2.9

Method Detail

formatTo back to summary

formatTo	back to summary
public void formatTo(final StringBuilder buffer) Implements org.apache.logging.log4j.util.StringBuilderFormattable.formatTo. Doc from org.apache.logging.log4j.util.StringBuilderFormattable.formatTo. Writes a text representation of this object into the specified `StringBuilder`, ideally without allocating temporary objects. Parameters buffer:StringBuilder the StringBuilder to write into Annotations @Override

public void formatTo(final StringBuilder buffer)

Implements org.apache.logging.log4j.util.StringBuilderFormattable.formatTo.

Doc from org.apache.logging.log4j.util.StringBuilderFormattable.formatTo.

Writes a text representation of this object into the specified StringBuilder, ideally without allocating temporary objects.

Parameters

buffer:StringBuilder: the StringBuilder to write into

Annotations

@Override

getEnterpriseNumber	back to summary
public String getEnterpriseNumber() Returns the enterprise number. Returns:String the enterprise number.

getEnterpriseNumber

back to summary

public String getEnterpriseNumber()

Returns the enterprise number.

Returns:String: the enterprise number.

getName	back to summary
public String getName() Returns the StructuredDataId name. Returns:String the StructuredDataId name.

getName

back to summary

public String getName()

Returns the StructuredDataId name.

Returns:String: the StructuredDataId name.

getOptional	back to summary
public String[] getOptional() Returns a list of optional keys. Returns:String[] a List of optional keys or null if none have been provided.

getOptional

back to summary

public String[] getOptional()

Returns a list of optional keys.

Returns:String[]: a List of optional keys or null if none have been provided.

getRequired	back to summary
public String[] getRequired() Returns a list of required keys. Returns:String[] a List of required keys or null if none have been provided.

getRequired

back to summary

public String[] getRequired()

Returns a list of required keys.

Returns:String[]: a List of required keys or null if none have been provided.

isReserved	back to summary
public boolean isReserved() Indicates if the id is reserved. Returns:boolean true if the id uses the reserved enterprise number, false otherwise.

isReserved

back to summary

public boolean isReserved()

Indicates if the id is reserved.

Returns:boolean: true if the id uses the reserved enterprise number, false otherwise.

makeId	back to summary
public StructuredDataId makeId(final StructuredDataId id) Creates an id using another id to supply default values. Parameters id:StructuredDataId The original StructuredDataId. Returns:StructuredDataId the new StructuredDataId.

makeId

back to summary

public StructuredDataId makeId(final StructuredDataId id)

Creates an id using another id to supply default values.

Parameters

id:StructuredDataId: The original StructuredDataId.

Returns:StructuredDataId

the new StructuredDataId.

makeId	back to summary
public StructuredDataId makeId(final String defaultId, final String anEnterpriseNumber) Creates an id based on the current id. Parameters defaultId:String The default id to use if this StructuredDataId doesn't have a name. anEnterpriseNumber:String The enterprise number. Returns:StructuredDataId a StructuredDataId.

makeId

back to summary

public StructuredDataId makeId(final String defaultId, final String anEnterpriseNumber)

Creates an id based on the current id.

Parameters

defaultId:String: The default id to use if this StructuredDataId doesn't have a name.
anEnterpriseNumber:String: The enterprise number.

Returns:StructuredDataId

a StructuredDataId.

makeId back to summary

makeId	back to summary
public final StructuredDataId makeId(final String defaultId, final int anEnterpriseNumber) Deprecated Use `StructuredDataId#makeId(String, String)` instead Creates an id based on the current id. Parameters defaultId:String The default id to use if this StructuredDataId doesn't have a name. anEnterpriseNumber:int The enterprise number. Returns:StructuredDataId a StructuredDataId. Annotations @Deprecated @BaselineIgnore:2.22.0 @InlineMe replacement:this.makeId(defaultId, String.valueOf(anEnterpriseNumber))

public final StructuredDataId makeId(final String defaultId, final int anEnterpriseNumber)

Deprecated

Use StructuredDataId#makeId(String, String) instead

Creates an id based on the current id.

Parameters

defaultId:String: The default id to use if this StructuredDataId doesn't have a name.
anEnterpriseNumber:int: The enterprise number.

Returns:StructuredDataId

a StructuredDataId.

Annotations

@Deprecated
@BaselineIgnore:2.22.0
@InlineMe
replacement:this.makeId(defaultId, String.valueOf(anEnterpriseNumber))

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class StructuredDataId

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail