public abstract class NodeUI
A Unique Identifier for a Node.
This class is different from NodeID
in that it does not describe the
Node's location.
Implementations of this class should provide a constructor that takes a
String
parameter which is in the format of the String
returned from the getImplStringForm()
method.
Type | Name and description |
---|---|
protected boolean |
checkEqual(NodeUI other) An abstract method to be implemented to return whether another NodeUI object is equal to this instance. |
int |
compareTo(Object o) Compares this NodeUI with another object. |
static NodeUI |
createFromStringForm(String stringForm) Creates a NodeUI from a String in the format of that returned from the getImplStringForm() method. |
boolean |
equals(Object o) Compares this NodeUI with another object.
|
protected String |
getComparisonString() This is an abstract method that should be implemented to return a String that can be used by the compareTo(Object)
method in order to compare two NodeUI objects. |
protected String |
getImplStringForm() Returns a String that can be supplied to the
static createFromStringForm(String) method in order to
create an equal NodeUI object. |
int |
hashCode() Returns an int hash code for this object.
|
An abstract method to be implemented to return whether another
NodeUI
object is equal to this instance. If the the
NodeUI
is of a different implementation class, the method
should return false
.
true
iff the supplied NodeUI
is equal to this one.other
- a NodeUI
to compare with this NodeUI
. Compares this NodeUI
with another object. This method
calls the implementation of the getComparisonString()
method
on both this NodeUI
object and the NodeUI
object
supplied. The String
class' compareTo(Object)
is
used to perform the comparison. The method is called on the String
returned by this object and the String
returned by the other object
is supplied as the parameter.
NodeUI
object.int
value that follows the rules of the
compareTo(Object)
method in the String
class.o
- another object to compare with this object. Creates a NodeUI from a String in the format of that returned from the
getImplStringForm()
method.
NodeUI
object.stringForm
- the String
to use in creating the NodeUI
object. Compares this NodeUI
with another object.
This method checks that the supplied object is a NodeUI
object
and then calls the implementation of the checkEqual(NodeUI)
method and returns its result value as the result of this method.
true
iff the supplied object is a NodeUI
and the
result of a call to the checkEqual(NodeUI)
method is true
.o
- an object to compare with this object. This is an abstract method that should be implemented to return a
String
that can be used by the compareTo(Object)
method in order to compare two NodeUI
objects.
Two NodeUI
objects should return equal
String
objects iff the two NodeUI
objects are equal.
String
that follows the above rules. Returns a String
that can be supplied to the
static createFromStringForm(String)
method in order to
create an equal NodeUI
object.
String
containing the necessary information to recreate this NodeUI
object. Returns an int
hash code for this object.
Two NodeUI
objects will return equal hash codes if the two objects
are equal.
int
hash code.