Package com.io7m.smfj.core
Class SMFAttributeName
- java.lang.Object
-
- com.io7m.smfj.core.SMFAttributeName
-
- All Implemented Interfaces:
SMFAttributeNameType
,java.lang.Comparable<SMFAttributeNameType>
public final class SMFAttributeName extends java.lang.Object implements SMFAttributeNameType
An attribute name.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SMFAttributeName.Builder
Builds instances of typeSMFAttributeName
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SMFAttributeName.Builder
builder()
Creates a builder forSMFAttributeName
.static SMFAttributeName
copyOf(SMFAttributeNameType instance)
Creates an immutable copy of aSMFAttributeNameType
value.boolean
equals(java.lang.Object another)
This instance is equal to all instances ofSMFAttributeName
that have equal attribute values.int
hashCode()
Computes a hash code from attributes:value
.static SMFAttributeName
of(java.lang.String value)
Construct a new immutableSMFAttributeName
instance.java.lang.String
toString()
Prints the immutable valueSMFAttributeName
with attribute values.java.lang.String
value()
SMFAttributeName
withValue(java.lang.String value)
Copy the current immutable object by setting a value for thevalue
attribute.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.io7m.smfj.core.SMFAttributeNameType
checkPreconditions, compareTo
-
-
-
-
Method Detail
-
value
public java.lang.String value()
- Specified by:
value
in interfaceSMFAttributeNameType
- Returns:
- The actual name value
-
withValue
public final SMFAttributeName withValue(java.lang.String value)
Copy the current immutable object by setting a value for thevalue
attribute. An equals check used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for value- Returns:
- A modified copy of the
this
object
-
equals
public boolean equals(java.lang.Object another)
This instance is equal to all instances ofSMFAttributeName
that have equal attribute values.- Overrides:
equals
in classjava.lang.Object
- Returns:
true
ifthis
is equal toanother
instance
-
hashCode
public int hashCode()
Computes a hash code from attributes:value
.- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- hashCode value
-
toString
public java.lang.String toString()
Prints the immutable valueSMFAttributeName
with attribute values.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A string representation of the value
-
of
public static SMFAttributeName of(java.lang.String value)
Construct a new immutableSMFAttributeName
instance.- Parameters:
value
- The value for thevalue
attribute- Returns:
- An immutable SMFAttributeName instance
-
copyOf
public static SMFAttributeName copyOf(SMFAttributeNameType instance)
Creates an immutable copy of aSMFAttributeNameType
value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.- Parameters:
instance
- The instance to copy- Returns:
- A copied immutable SMFAttributeName instance
-
builder
public static SMFAttributeName.Builder builder()
Creates a builder forSMFAttributeName
.SMFAttributeName.builder() .setValue(String) // required
value
.build();- Returns:
- A new SMFAttributeName builder
-
-