ptolemy.graph
Class Node

java.lang.Object
  ptolemy.graph.Element
      ptolemy.graph.Node

public final class Node
extends Element

An optionally-weighted node for an undirected or directed graph. More specifically, a node consists of an optional weight (an arbitrary object that is associated with the node). We say that a node is unweighted if it does not have an assigned weight. It is an error to attempt to access the weight of an unweighted node. Node weights must be genuine (non-null) objects.

Since:

Ptolemy II 2.0

Version:

$Id: Node.java 41477 2006-03-29 00:03:58Z cxh $

Author:

Shuvra S. Bhattacharyya

See Also:

Edge

Accepted Rating:

Red (cxh)

Proposed Rating:

Red (cxh)

Field Summary

Fields inherited from class ptolemy.graph.Element

_weight

Constructor Summary

Node()
Construct an unweighted node.

Node(java.lang.Object weight)
Construct a node with a given node weight.

Method Summary

java.lang.String	descriptor() A one-word description of the type of this graph element.
java.lang.String	toString() Return a string representation of the node.

Methods inherited from class ptolemy.graph.Element

getWeight, hasWeight, removeWeight, setWeight

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Node

public Node()

Construct an unweighted node.

Node

public Node(java.lang.Object weight)

Construct a node with a given node weight.

Parameters:

weight - The given weight.

Throws:

java.lang.IllegalArgumentException - If the specified weight is null.

Method Detail

descriptor

public java.lang.String descriptor()

A one-word description of the type of this graph element.

Overrides:

descriptor in class Element

Returns:

The description.

toString

public java.lang.String toString()

Return a string representation of the node. The string representation is simply a representation of the node weight (or the string "<unweighted node>" if the node is unweighted.

Overrides:

toString in class java.lang.Object