@Immutable public abstract class TagKey extends Object
TagContext
.
Each TagKey
has a String
name. Names have a maximum length of MAX_LENGTH
and contain only printable ASCII characters.
TagKey
s are designed to be used as constants. Declaring each key as a constant
prevents key names from being validated multiple times.
Modifier and Type | Field and Description |
---|---|
static int |
MAX_LENGTH
The maximum length for a tag key name.
|
Modifier and Type | Method and Description |
---|---|
static TagKey |
create(String name)
Constructs a
TagKey with the given name. |
abstract String |
getName()
Returns the name of the key.
|
public static final int MAX_LENGTH
public static TagKey create(String name)
TagKey
with the given name.
The name must meet the following requirements:
MAX_LENGTH
.
name
- the name of the key.TagKey
with the given name.IllegalArgumentException
- if the name is not valid.public abstract String getName()