Serializable
, StringBuilderFormattable
public class StructuredDataId extends Object implements Serializable, StringBuilderFormattable
Modifier and Type | Field | Description |
---|---|---|
static StructuredDataId |
META |
RFC 5424 Meta.
|
static StructuredDataId |
ORIGIN |
RFC 5424 Origin.
|
static int |
RESERVED |
Reserved enterprise number.
|
static StructuredDataId |
TIME_QUALITY |
RFC 5424 Time Quality.
|
Constructor | Description |
---|---|
StructuredDataId(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.
|
Modifier and Type | Method | Description |
---|---|---|
void |
formatTo(StringBuilder buffer) |
Writes a text representation of this object into the specified
StringBuilder , ideally without allocating
temporary objects. |
int |
getEnterpriseNumber() |
Returns the enterprise number.
|
String |
getName() |
Returns the StructuredDataId name.
|
String[] |
getOptional() |
Returns a list of optional keys.
|
String[] |
getRequired() |
Returns a list of required keys.
|
boolean |
isReserved() |
Indicates if the id is reserved.
|
StructuredDataId |
makeId(String defaultId,
int anEnterpriseNumber) |
Creates an id based on the current id.
|
StructuredDataId |
makeId(StructuredDataId id) |
Creates an id using another id to supply default values.
|
String |
toString() |
public static final StructuredDataId TIME_QUALITY
public static final StructuredDataId ORIGIN
public static final StructuredDataId META
public static final int RESERVED
public StructuredDataId(String name)
name
- The Structured Data Element name (maximum length is 32)public StructuredDataId(String name, int maxLength)
name
- The Structured Data Element name.maxLength
- The maximum length of the name.public StructuredDataId(String name, String[] required, String[] optional)
name
- required
- optional
- public StructuredDataId(String name, String[] required, String[] optional, int maxLength)
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.public StructuredDataId(String name, int enterpriseNumber, String[] required, String[] optional)
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.public StructuredDataId(String name, int enterpriseNumber, String[] required, String[] optional, int maxLength)
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.public StructuredDataId makeId(StructuredDataId id)
id
- The original StructuredDataId.public StructuredDataId makeId(String defaultId, int anEnterpriseNumber)
defaultId
- The default id to use if this StructuredDataId doesn't have a name.anEnterpriseNumber
- The enterprise number.public String[] getRequired()
public String[] getOptional()
public String getName()
public int getEnterpriseNumber()
public boolean isReserved()
public void formatTo(StringBuilder buffer)
StringBuilderFormattable
StringBuilder
, ideally without allocating
temporary objects.formatTo
in interface StringBuilderFormattable
buffer
- the StringBuilder to write intoCopyright © 1999-2018. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.