net.spy.util
Class AbstractSPNode

java.lang.Object
  net.spy.SpyObject
      net.spy.util.AbstractSPNode

All Implemented Interfaces:

java.lang.Comparable, SPNode

public abstract class AbstractSPNode
extends SpyObject
implements SPNode

Abstract implementation of SPNode to make implementation a bit easier.

Constructor Summary

protected	AbstractSPNode() Get an instance of AbstractSPNode.
protected	AbstractSPNode(java.util.SortedSet links) Get an instance of AbstractSPNode holding its links in the given Set.

Method Summary

void	addNextHop(SPNode n, SPVertex v) Add a vertex to the next hop database to take you to a particular location.
void	clearNextHops() Clear out the next hop map.
boolean	equals(java.lang.Object o) Object.equals must be overridden to return results consistent to compareTo(other).
java.util.SortedSet	getConnections() Get all of the connections to other nodes.
SPVertex	getNextHop(SPNode n) Get the next hop to take you to the given node.
java.util.Map	getNextHops() Get the mapping of SPNode -> SPVertex hops for this SPNode.
abstract int	hashCode() Must override hashCode along with compareTo();
protected void	linkTo(SPNode n) Link this SPNode to the given SPNode at the default cost.
protected void	linkTo(SPNode n, int cost) Link this SPNode to the given SPNode at the given cost.

Methods inherited from class net.spy.SpyObject

getLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

AbstractSPNode

protected AbstractSPNode(java.util.SortedSet links)

Get an instance of AbstractSPNode holding its links in the given Set.

AbstractSPNode

protected AbstractSPNode()

Get an instance of AbstractSPNode.

Method Detail

linkTo

protected void linkTo(SPNode n,
                      int cost)

Link this SPNode to the given SPNode at the given cost.

Parameters:

n - SPNode to which to link

cost - cost of this link

linkTo

protected void linkTo(SPNode n)

Link this SPNode to the given SPNode at the default cost.

Parameters:

n - the node to which to link

getConnections

public java.util.SortedSet getConnections()

Description copied from interface: SPNode

Get all of the connections to other nodes.

Specified by:

getConnections in interface SPNode

Returns:

a SortedSet of SPVertex objects.

See Also:

SPNode

getNextHops

public java.util.Map getNextHops()

Description copied from interface: SPNode

Get the mapping of SPNode -> SPVertex hops for this SPNode.

Specified by:

getNextHops in interface SPNode

Returns:

an unmodifiable Map representing mapping

See Also:

SPNode

clearNextHops

public void clearNextHops()

Description copied from interface: SPNode

Clear out the next hop map. This should only be called by an ShortestPathFinder.

Specified by:

clearNextHops in interface SPNode

See Also:

SPNode

getNextHop

public SPVertex getNextHop(SPNode n)

Description copied from interface: SPNode

Get the next hop to take you to the given node.

Specified by:

getNextHop in interface SPNode

Parameters:

n - the node you want to get to

Returns:

the vertex describing the next hop, or null if there's no route to the given node

See Also:

SPNode

addNextHop

public void addNextHop(SPNode n,
                       SPVertex v)

Description copied from interface: SPNode

Add a vertex to the next hop database to take you to a particular location. This is used just for routing information, not normal links. This should only be called by a ShortestPathFinder.

Specified by:

addNextHop in interface SPNode

Parameters:

n - the destination node

v - the vertex that will take you there

See Also:

SPNode

equals

public boolean equals(java.lang.Object o)

Description copied from interface: SPNode

Object.equals must be overridden to return results consistent to compareTo(other).

Specified by:

equals in interface SPNode

Overrides:

equals in class java.lang.Object

Parameters:

o - the object to which to compare

Returns:

true if the objects are equal

See Also:

Object

hashCode

public abstract int hashCode()

Must override hashCode along with compareTo();

Specified by:

hashCode in interface SPNode

Overrides:

hashCode in class java.lang.Object