Package org.jcsp.net

Class DomainID

java.lang.Object
org.jcsp.net.AbstractID
org.jcsp.net.DomainID
All Implemented Interfaces:
Serializable, Comparable
public final class DomainID extends AbstractID implements Serializable, 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.

See Also:

  • Field Details

  • Constructor Details

    • DomainID

      DomainID()
      Constructor which constructs an ID for the Null Domain.

    • DomainID

      public DomainID(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 Details

    • createFromStringForm

      static DomainID createFromStringForm(String str) throws IllegalArgumentException
      Deprecated.
      not needed now channel names abstracted
      Throws:
      IllegalArgumentException

    • equals

      public boolean equals(Object o)
      This compares an object with this object.
      Overrides:
      equals in class 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 Object
      Returns:
      an int hash code.

    • compareTo

      public int compareTo(Object o)

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

      Specified by:
      compareTo in interface 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.

    • onSameBranch

      boolean onSameBranch(AbstractID abstractID)
      Description copied from class: AbstractID
      This tests whether another ID is on the same branch of a hierachy. Returns true if either the supplied object is a child (or a child of child etc.) of this object or if the supplied object is a parent (or a parent of a parent etc.) of this object.
      Specified by:
      onSameBranch in class AbstractID
      Returns:
      a boolean indicating whether or not the supplied object is on the same branch.

    • isNullDomain

      boolean isNullDomain()

    • getNullDomainID

      static DomainID getNullDomainID()

    • getDomainName

      public String getDomainName()

      Public accessor for the Domain name.

      Returns "" if this represents the Null Domain.

      Returns:
      the domain name as a String.

    • toString

      public String toString()

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

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

    • getStringForm

      String getStringForm()
      Deprecated.
      not needed now channel names abstracted

    • 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.