public class StructuredDataId extends java.lang.Object implements java.io.Serializable, StringBuilderFormattable
Modifier and Type | Field and Description |
---|---|
private static java.lang.String |
AT_SIGN |
private int |
enterpriseNumber |
private static int |
MAX_LENGTH |
static StructuredDataId |
META
RFC 5424 Meta.
|
private java.lang.String |
name |
private java.lang.String[] |
optional |
static StructuredDataId |
ORIGIN
RFC 5424 Origin.
|
private java.lang.String[] |
required |
static int |
RESERVED
Reserved enterprise number.
|
private static long |
serialVersionUID |
static StructuredDataId |
TIME_QUALITY
RFC 5424 Time Quality.
|
Modifier | Constructor and Description |
---|---|
|
StructuredDataId(java.lang.String name,
int enterpriseNumber,
java.lang.String[] required,
java.lang.String[] optional)
A Constructor that helps conformance to RFC 5424.
|
protected |
StructuredDataId(java.lang.String name,
java.lang.String[] required,
java.lang.String[] optional) |
Modifier and Type | Method and Description |
---|---|
void |
formatTo(java.lang.StringBuilder buffer)
Writes a text representation of this object into the specified
StringBuilder , ideally without allocating
temporary objects. |
int |
getEnterpriseNumber()
Returns the enterprise number.
|
java.lang.String |
getName()
Returns the StructuredDataId name.
|
java.lang.String[] |
getOptional()
Returns a list of optional keys.
|
java.lang.String[] |
getRequired()
Returns a list of required keys.
|
boolean |
isReserved()
Indicates if the id is reserved.
|
StructuredDataId |
makeId(java.lang.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.
|
java.lang.String |
toString() |
public static final StructuredDataId TIME_QUALITY
public static final StructuredDataId ORIGIN
public static final StructuredDataId META
public static final int RESERVED
private static final long serialVersionUID
private static final int MAX_LENGTH
private static final java.lang.String AT_SIGN
private final java.lang.String name
private final int enterpriseNumber
private final java.lang.String[] required
private final java.lang.String[] optional
protected StructuredDataId(java.lang.String name, java.lang.String[] required, java.lang.String[] optional)
public StructuredDataId(java.lang.String name, int enterpriseNumber, java.lang.String[] required, java.lang.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 makeId(StructuredDataId id)
id
- The original StructuredDataId.public StructuredDataId makeId(java.lang.String defaultId, int anEnterpriseNumber)
defaultId
- The default id to use if this StructuredDataId doesn't have a name.anEnterpriseNumber
- The enterprise number.public java.lang.String[] getRequired()
public java.lang.String[] getOptional()
public java.lang.String getName()
public int getEnterpriseNumber()
public boolean isReserved()
public java.lang.String toString()
toString
in class java.lang.Object
public void formatTo(java.lang.StringBuilder buffer)
StringBuilderFormattable
StringBuilder
, ideally without allocating
temporary objects.formatTo
in interface StringBuilderFormattable
buffer
- the StringBuilder to write into