Neighbor

java.lang.Object
- Neighbor

All Implemented Interfaces:

java.lang.Comparable<Neighbor>
```
public class Neighbor
extends java.lang.Object
implements java.lang.Comparable<Neighbor>
```
Used by GraphNode class to keep a list of 'this' node's neighbors and the cost to reach each of those neighbors. Stores the neignbor node and the cost to travel from this node to this neighbor node. Instances of this class are created to establish an edge (path) from 'this' GraphNode to the specified neighbor node.

Constructor Summary

Constructors
Constructor and Description
`Neighbor(int cost, GraphNode neighbor)` A neighbor is added to an existing GraphNode by creating an instance of Neighbor that stores the neighbor and the cost to reach that neighbor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Neighbor otherNode)` Compares the node names of this node and the otherNode.
`int`	`getCost()` Returns the cost of travelling this edge to get to the Neighbor at the other end of this edge.
`GraphNode`	`getNeighborNode()` Returns the Neighbor (node) that is at the other end of "this" node's edge.
`java.lang.String`	`toString()` Returns a String representation of this Neighbor.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Neighbor
```
public Neighbor(int cost,
                GraphNode neighbor)
```
    A neighbor is added to an existing GraphNode by creating an instance of Neighbor that stores the neighbor and the cost to reach that neighbor.
    
    Parameters:
    
    cost - The cost to reach this neighbor.
    
    neighbor - The neighbor node being reached by this edge.
- Method Detail
  - getCost
```
public int getCost()
```
    Returns the cost of travelling this edge to get to the Neighbor at the other end of this edge.
    
    Returns:
    
    the cost of the edge to get to this neighbor
  - getNeighborNode
```
public GraphNode getNeighborNode()
```
    Returns the Neighbor (node) that is at the other end of "this" node's edge.
    
    Returns:
    
    the neighbor node itself.
  - compareTo
```
public int compareTo(Neighbor otherNode)
```
    Compares the node names of this node and the otherNode. Returns the results of comparing this node's name to the otherNode's name. Allows Lists of Neighbors to be sorted using built-in sort methods.
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<Neighbor>
    
    Parameters:
    
    otherNode - neighbor to be compared
    
    Returns:
    
    compareTo the node names of two neighbors
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this Neighbor. The String that is returned shows an arrow (with the cost in the middle) and then the Neighbor node's name. Example:
```
 --1--> b 
```
    indicates a cost of 1 to get to node b
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a String with the cost and destination node:

Class Neighbor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Neighbor

Method Detail

getCost

getNeighborNode

compareTo

toString