Class Identifier

  • All Implemented Interfaces:
    HasJsonKey

    public final class Identifier
    extends Object
    implements HasJsonKey
    An identifier for a resource.
    Author:
    Ryan Heaton
    • Constructor Detail

      • Identifier

        public Identifier()
      • Identifier

        public Identifier​(URI value)
    • 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.OTHER if 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.
      • toString

        public String toString()
        Provide a simple toString() method.
        Overrides:
        toString in class Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object