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.- Author:
- Quickstone Technologies Limited
- See Also:
- Serialized Form
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compareTo(Object o)
Compares this object with another object and returns whether the supplied object is equals, smaller or larger.boolean
equals(Object o)
This compares an object with this object.String
getDomainName()
Public accessor for the Domain name.AbstractID
getParentID()
Returns the identifier representing this domain's parent domain.int
hashCode()
Returns anint
hash code for the current object.String
toString()
Returns a human readableString
showing this domain name and any parent domains.
-
-
-
Constructor Detail
-
DomainID
public DomainID(String name)
Public constructor for aDomainID
which takes the name of the domain as a parameter.- Parameters:
name
- The name of the domain.
-
-
Method Detail
-
equals
public boolean equals(Object o)
This compares an object with this object.
-
hashCode
public int hashCode()
Returns an
int
hash code for the current object.This obeys the standard hash code rules.
-
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 interfaceComparable
- 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 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.
-
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 classAbstractID
- Returns:
- the parent
AbstractID
.
-
-