Package com.ibm.wala.util.graph

Class AbstractGraph<T>

java.lang.Object

com.ibm.wala.util.graph.AbstractGraph<T>

All Implemented Interfaces:

EdgeManager<T>, Graph<T>, NodeManager<T>, Iterable<T>

Direct Known Subclasses:

AbstractLabeledGraph, AbstractNumberedGraph, BasicGraph, InvertedGraph, SelfLoopAddedGraph

public abstract class AbstractGraph<T>
extends Object
implements Graph<T>

Basic functionality for a Graph that delegates node and edge management.

Constructor Summary

Constructors

Constructor	Description
AbstractGraph()

Method Summary

Modifier and Type	Method	Description
void	addEdge(T src, T dst)
void	addNode(T n)	add a node to this graph
boolean	containsNode(@Nullable T n)
protected String	edgeString(T from, T to)
protected abstract EdgeManager<T>	getEdgeManager()
protected abstract NodeManager<T>	getNodeManager()
int	getNumberOfNodes()
int	getPredNodeCount(T n)	Return the number of immediate predecessor nodes of n
Iterator<T>	getPredNodes(@Nullable T n)	Return an Iterator over the immediate predecessor nodes of n
int	getSuccNodeCount(T n)	Return the number of immediate successor nodes of this Node in the Graph
Iterator<T>	getSuccNodes(@Nullable T n)	Return an Iterator over the immediate successor nodes of n
boolean	hasEdge(@Nullable T src, @Nullable T dst)
Iterator<T>	iterator()
protected String	nodeString(T n, boolean forEdge)
void	removeAllIncidentEdges(T node)
void	removeEdge(T src, T dst)
void	removeIncomingEdges(T node)
void	removeNode(T n)	remove a node from this graph
void	removeNodeAndEdges(T N)	remove a node and all its incident edges
void	removeOutgoingEdges(T node)
Stream<T>	stream()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

AbstractGraph

public AbstractGraph()

Method Detail

getNodeManager

protected abstract NodeManager<T> getNodeManager()

Returns:

the object which manages nodes in the graph

getEdgeManager

protected abstract EdgeManager<T> getEdgeManager()

Returns:

the object which manages edges in the graph

stream

public Stream<T> stream()

Specified by:

stream in interface NodeManager<T>

Returns:

a Stream of the nodes in this graph

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

Specified by:

iterator in interface NodeManager<T>

Returns:

an Iterator of the nodes in this graph

See Also:

NodeManager.iterator()

getNumberOfNodes

public int getNumberOfNodes()

Specified by:

getNumberOfNodes in interface NodeManager<T>

Returns:

the number of nodes in this graph

See Also:

NodeManager.getNumberOfNodes()

getPredNodeCount

public int getPredNodeCount(T n)
                     throws IllegalArgumentException

Description copied from interface: EdgeManager

Return the number of immediate predecessor nodes of n

Specified by:

getPredNodeCount in interface EdgeManager<T>

Returns:

the number of immediate predecessors of n.

Throws:

IllegalArgumentException

See Also:

EdgeManager.getPredNodeCount(java.lang.Object)

getPredNodes

public Iterator<T> getPredNodes(@Nullable T n)
                         throws IllegalArgumentException

Description copied from interface: EdgeManager

Return an Iterator over the immediate predecessor nodes of n

This method never returns null.

Specified by:

getPredNodes in interface EdgeManager<T>

Returns:

an Iterator over the immediate predecessor nodes of this Node.

Throws:

IllegalArgumentException

See Also:

EdgeManager.getPredNodes(java.lang.Object)

getSuccNodeCount

public int getSuccNodeCount(T n)
                     throws IllegalArgumentException

Description copied from interface: EdgeManager

Return the number of immediate successor nodes of this Node in the Graph

Specified by:

getSuccNodeCount in interface EdgeManager<T>

Returns:

the number of immediate successor Nodes of this Node in the Graph.

Throws:

IllegalArgumentException

See Also:

EdgeManager.getSuccNodeCount(java.lang.Object)

getSuccNodes

public Iterator<T> getSuccNodes(@Nullable T n)
                         throws IllegalArgumentException

Description copied from interface: EdgeManager

Return an Iterator over the immediate successor nodes of n

This method never returns null.

Specified by:

getSuccNodes in interface EdgeManager<T>

Returns:

an Iterator over the immediate successor nodes of n

Throws:

IllegalArgumentException

See Also:

EdgeManager.getSuccNodes(java.lang.Object)

addNode

public void addNode(T n)

Description copied from interface: NodeManager

add a node to this graph

Specified by:

addNode in interface NodeManager<T>

See Also:

NodeManager.addNode(Object)

addEdge

public void addEdge(T src,
                    T dst)
             throws IllegalArgumentException

Specified by:

addEdge in interface EdgeManager<T>

Throws:

IllegalArgumentException

See Also:

EdgeManager.addEdge(Object, Object)

removeEdge

public void removeEdge(T src,
                       T dst)
                throws IllegalArgumentException

Specified by:

removeEdge in interface EdgeManager<T>

Throws:

IllegalArgumentException

See Also:

EdgeManager.removeEdge(java.lang.Object, java.lang.Object)

hasEdge

public boolean hasEdge(@Nullable T src,
                       @Nullable T dst)

Specified by:

hasEdge in interface EdgeManager<T>

See Also:

EdgeManager.hasEdge(java.lang.Object, java.lang.Object)

removeAllIncidentEdges

public void removeAllIncidentEdges(T node)
                            throws IllegalArgumentException

Specified by:

removeAllIncidentEdges in interface EdgeManager<T>

Throws:

IllegalArgumentException

See Also:

EdgeManager.removeAllIncidentEdges(Object)

removeIncomingEdges

public void removeIncomingEdges(T node)
                         throws IllegalArgumentException

Specified by:

removeIncomingEdges in interface EdgeManager<T>

Throws:

IllegalArgumentException

See Also:

EdgeManager.removeAllIncidentEdges(Object)

removeOutgoingEdges

public void removeOutgoingEdges(T node)
                         throws IllegalArgumentException

Specified by:

removeOutgoingEdges in interface EdgeManager<T>

Throws:

IllegalArgumentException

See Also:

EdgeManager.removeAllIncidentEdges(Object)

removeNodeAndEdges

public void removeNodeAndEdges(T N)
                        throws IllegalArgumentException

Description copied from interface: Graph

remove a node and all its incident edges

Specified by:

removeNodeAndEdges in interface Graph<T>

Throws:

IllegalArgumentException

See Also:

NodeManager.removeNode(Object)

removeNode

public void removeNode(T n)
                throws IllegalArgumentException

Description copied from interface: NodeManager

remove a node from this graph

Specified by:

removeNode in interface NodeManager<T>

Throws:

IllegalArgumentException

See Also:

NodeManager.removeNode(Object)

nodeString

protected String nodeString(T n,
                            boolean forEdge)

edgeString

protected String edgeString(T from,
                            T to)

toString

public String toString()

Overrides:

toString in class Object

containsNode

public boolean containsNode(@Nullable T n)

Specified by:

containsNode in interface NodeManager<T>

Returns:

true iff the graph contains the specified node

See Also:

NodeManager.containsNode(Object)