Package org.gedcomx.conclusion
Class Identifier
- java.lang.Object
-
- org.gedcomx.conclusion.Identifier
-
- All Implemented Interfaces:
HasJsonKey
public final class Identifier extends Object implements HasJsonKey
An identifier for a resource.- Author:
- Ryan Heaton
-
-
Constructor Summary
Constructors Constructor Description Identifier()Identifier(URI value)Identifier(URI value, IdentifierType knownType)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object o)StringgetJsonKey()IdentifierTypegetKnownType()The enum referencing a known identifier type.URIgetType()The type of the id.URIgetValue()The id value.inthashCode()booleanisHasUniqueKey()voidsetJsonKey(String jsonKey)voidsetKnownType(IdentifierType knownType)Set the value of the id type from a known identifier type.voidsetType(URI type)The type of the id.voidsetType(URI type, boolean unique)The type of the id.voidsetValue(URI value)The id value.StringtoString()Provide a simple toString() method.Identifiertype(URI type)Build up this identifier with a type.Identifiertype(IdentifierType type)Build up this identifier with a type.Identifiervalue(URI value)Build up this identifier with a value.
-
-
-
Constructor Detail
-
Identifier
public Identifier()
-
Identifier
public Identifier(URI value)
-
Identifier
public Identifier(URI value, IdentifierType knownType)
-
-
Method Detail
-
getValue
public URI getValue()
The id value.- Returns:
- The id value.
-
setValue
public void setValue(URI value)
The id value.- Parameters:
value- The id value.
-
value
public Identifier value(URI value)
Build up this identifier with a value.- Parameters:
value- The value.- Returns:
- this.
-
getType
public URI getType()
The type of the id.- Returns:
- The type of the id.
-
setType
public void setType(URI type)
The type of the id.- Parameters:
type- The type of the id.
-
type
public Identifier type(URI type)
Build up this identifier with a type.- Parameters:
type- The type.- Returns:
- this.
-
type
public Identifier type(IdentifierType type)
Build up this identifier with a type.- Parameters:
type- The type.- Returns:
- this.
-
setType
public void setType(URI type, boolean unique)
The type of the id.- Parameters:
type- The type of the id.unique- Whether the type of this identifier implies that the value is unique among all other identifiers of the same type.
-
getKnownType
public IdentifierType getKnownType()
The enum referencing a known identifier type.- Returns:
- The enum referencing a known identifier type, or
IdentifierType.OTHERif not known.
-
setKnownType
public void setKnownType(IdentifierType knownType)
Set the value of the id type from a known identifier type.- Parameters:
knownType- The known identifier type.
-
isHasUniqueKey
public boolean isHasUniqueKey()
- Specified by:
isHasUniqueKeyin interfaceHasJsonKey
-
getJsonKey
public String getJsonKey()
- Specified by:
getJsonKeyin interfaceHasJsonKey
-
setJsonKey
public void setJsonKey(String jsonKey)
- Specified by:
setJsonKeyin interfaceHasJsonKey
-
toString
public String toString()
Provide a simple toString() method.
-
-