Package org.jcsp.net

Class DomainID

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable
    public final class DomainID
extends AbstractID
implements java.io.Serializable, java.lang.Comparable

    A Class whose instances represent a unique identifier for a JCSP.NET domain.

    See AbstractID for a further explanation of domains and the use of this class.

    Author:
    Quickstone Technologies Limited
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      DomainID​(java.lang.String name)
      Public constructor for a DomainID which takes the name of the domain as a parameter.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int compareTo​(java.lang.Object o)
      Compares this object with another object and returns whether the supplied object is equals, smaller or larger.
      boolean equals​(java.lang.Object o)
      This compares an object with this object.
      java.lang.String getDomainName()
      Public accessor for the Domain name.
      AbstractID getParentID()
      Returns the identifier representing this domain's parent domain.
      int hashCode()
      Returns an int hash code for the current object.
      java.lang.String toString()
      Returns a human readable String showing this domain name and any parent domains.

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • DomainID

        public DomainID​(java.lang.String name)
        Public constructor for a DomainID which takes the name of the domain as a parameter.
        Parameters:
        name - The name of the domain.

    • Method Detail

      • equals

        public boolean equals​(java.lang.Object o)
        This compares an object with this object.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        o - an object to compare with this object.
        Returns:
        true iff the supplied object is a non-null DomainID which represents the same Domain.

      • hashCode

        public int hashCode()

        Returns an int hash code for the current object.

        This obeys the standard hash code rules.

        Overrides:
        hashCode in class java.lang.Object
        Returns:
        an int hash code.

      • compareTo

        public int compareTo​(java.lang.Object o)

        Compares this object with another object and returns whether the supplied object is equals, smaller or larger.

        Specified by:
        compareTo in interface java.lang.Comparable
        Parameters:
        o - The object to compare with this object.
        Returns:
        0 if the supplied object is equal, a negative integer if the supplied object is smaller or a positive integer if the other object is larger.

      • getDomainName

        public java.lang.String getDomainName()

        Public accessor for the Domain name.

        Returns "" if this represents the Null Domain.

        Returns:
        the domain name as a String.

      • toString

        public java.lang.String toString()

        Returns a human readable String showing this domain name and any parent domains.

        Overrides:
        toString in class java.lang.Object
        Returns:
        the human readable String.

      • getParentID

        public AbstractID getParentID()

        Returns the identifier representing this domain's parent domain.

        At present this always returns the global domain's ID.

        Specified by:
        getParentID in class AbstractID
        Returns:
        the parent AbstractID.