org.jcsp.net

Class DomainID

java.lang.Object

org.jcsp.net.AbstractID

org.jcsp.net.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.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	DomainStringFormPrefix
private java.lang.String	name
private boolean	nullDom
private static java.lang.String	NullDomainStringForm

Constructor Summary

Constructors

Constructor and Description
DomainID() Constructor which constructs an ID for the Null Domain.
DomainID(java.lang.String name) Public constructor for a DomainID which takes the name of the domain as a parameter.

Method Summary

Modifier and Type	Method and Description
int	compareTo(java.lang.Object o) Compares this object with another object and returns whether the supplied object is equals, smaller or larger.
(package private) static DomainID	createFromStringForm(java.lang.String str) Deprecated. not needed now channel names abstracted
boolean	equals(java.lang.Object o) This compares an object with this object.
java.lang.String	getDomainName() Public accessor for the Domain name.
(package private) static DomainID	getNullDomainID()
AbstractID	getParentID() Returns the identifier representing this domain's parent domain.
(package private) java.lang.String	getStringForm() Deprecated. not needed now channel names abstracted
int	hashCode() Returns an int hash code for the current object.
(package private) boolean	isNullDomain()
(package private) boolean	onSameBranch(AbstractID abstractID) This tests whether another ID is on the same branch of a hierachy.
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

Field Detail

nullDom

private boolean nullDom

name

private java.lang.String name

NullDomainStringForm

private static final java.lang.String NullDomainStringForm

See Also:

Constant Field Values

DomainStringFormPrefix

private static final java.lang.String DomainStringFormPrefix

See Also:

Constant Field Values

Constructor Detail

DomainID

DomainID()

Constructor which constructs an ID for the Null Domain.

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

createFromStringForm

static DomainID createFromStringForm(java.lang.String str)
                              throws java.lang.IllegalArgumentException

Deprecated. not needed now channel names abstracted

Throws:

java.lang.IllegalArgumentException

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.

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

getStringForm

java.lang.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.