edu.uci.ics.dillenco.simplegraph01
Class NodeMap<V>

java.lang.Object
  extended by edu.uci.ics.dillenco.simplegraph01.SimpleMap
      extended by edu.uci.ics.dillenco.simplegraph01.NodeMap<V>

public final class NodeMap<V>
extends SimpleMap

This class maps Nodes of a given graph to user-defined attributes. it provides a scaled-down version of mapping: only put, get, clear, and isEmpty are supported.


Field Summary
 
Fields inherited from class edu.uci.ics.dillenco.simplegraph01.SimpleMap
graph
 
Constructor Summary
NodeMap(Graph g)
          Create an empty NodeMap for the given graph.
 
Method Summary
 void clear()
          Remove all stored values in this map
 V get(Node node)
          Retrieve the value associated with the given Node.
 boolean isEmpty()
          Return whether this map is currently empty.
 V put(Node node, V value)
          Store a <Node,V> pair.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NodeMap

public NodeMap(Graph g)
Create an empty NodeMap for the given graph.

Parameters:
g - the graph with which this map is to be associated.
Method Detail

put

public V put(Node node,
             V value)
Store a <Node,V> pair.

Parameters:
node - the Node for the pair, which functions as the key
value - the associated value
Returns:
the previous value associated with the Node, or null if there was no previous mapping for the Node.

get

public V get(Node node)
Retrieve the value associated with the given Node.

Parameters:
node - the Node
Returns:
the associated value.

clear

public void clear()
Remove all stored values in this map

Specified by:
clear in class SimpleMap

isEmpty

public boolean isEmpty()
Description copied from class: SimpleMap
Return whether this map is currently empty.

Specified by:
isEmpty in class SimpleMap
Returns:
true if the map is empty.