soot.toolkits.graph

Class HashMutableEdgeLabelledDirectedGraph

java.lang.Object

soot.toolkits.graph.HashMutableEdgeLabelledDirectedGraph

All Implemented Interfaces:

java.lang.Iterable, DirectedGraph, MutableEdgeLabelledDirectedGraph

Direct Known Subclasses:

HashMutablePDG

public class HashMutableEdgeLabelledDirectedGraph
extends java.lang.Object
implements MutableEdgeLabelledDirectedGraph

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.HashMap<soot.toolkits.graph.DGEdge,java.util.ArrayList<java.lang.Object>>	edgeToLabels
protected Chain	heads
protected java.util.HashMap<java.lang.Object,java.util.ArrayList<soot.toolkits.graph.DGEdge>>	labelToEdges
protected java.util.HashMap<java.lang.Object,java.util.ArrayList>	nodeToPreds
protected java.util.HashMap<java.lang.Object,java.util.ArrayList>	nodeToSuccs
protected Chain	tails

Constructor Summary

Constructors

Constructor and Description
HashMutableEdgeLabelledDirectedGraph()

Method Summary

Modifier and Type	Method and Description
void	addEdge(java.lang.Object from, java.lang.Object to, java.lang.Object label) Adds an edge to the graph between 2 nodes.
void	addNode(java.lang.Object node) Adds a node to the graph.
void	clearAll() Removes all nodes and edges.
java.lang.Object	clone()
boolean	containsAnyEdge(java.lang.Object label)
boolean	containsAnyEdge(java.lang.Object from, java.lang.Object to)
boolean	containsEdge(java.lang.Object from, java.lang.Object to, java.lang.Object label)
boolean	containsNode(java.lang.Object node)
MutableDirectedGraph	getEdgesForLabel(java.lang.Object label) Returns a MutableDirectedGraph consisting of all edges with the given label and their nodes.
java.util.List	getHeads() Returns a list of entry points for this graph.
java.util.List<java.lang.Object>	getLabelsForEdges(java.lang.Object from, java.lang.Object to) Returns a list of labels for which an edge exists between from and to
java.util.List<java.lang.Object>	getNodes()
java.util.List	getPredsOf(java.lang.Object s) Returns a list of predecessors for the given node in the graph.
java.util.List	getSuccsOf(java.lang.Object s) Returns a list of successors for the given node in the graph.
java.util.List	getTails() Returns a list of exit points for this graph.
java.util.Iterator	iterator() Returns an iterator for the nodes in this graph.
void	printGraph()
void	removeAllEdges(java.lang.Object label) Removes all edges with the given label in the graph.
void	removeAllEdges(java.lang.Object from, java.lang.Object to) Removes all edges between 2 nodes in the graph.
void	removeEdge(java.lang.Object from, java.lang.Object to, java.lang.Object label) Removes an edge between 2 nodes in the graph.
void	removeNode(java.lang.Object node) Removes a node from the graph.
int	size() Returns the node count for this graph.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

nodeToPreds

protected java.util.HashMap<java.lang.Object,java.util.ArrayList> nodeToPreds

nodeToSuccs

protected java.util.HashMap<java.lang.Object,java.util.ArrayList> nodeToSuccs

edgeToLabels

protected java.util.HashMap<soot.toolkits.graph.DGEdge,java.util.ArrayList<java.lang.Object>> edgeToLabels

labelToEdges

protected java.util.HashMap<java.lang.Object,java.util.ArrayList<soot.toolkits.graph.DGEdge>> labelToEdges

heads

protected Chain heads

tails

protected Chain tails

Constructor Detail

HashMutableEdgeLabelledDirectedGraph

public HashMutableEdgeLabelledDirectedGraph()

Method Detail

clearAll

public void clearAll()

Removes all nodes and edges.

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

getHeads

public java.util.List getHeads()

Description copied from interface: DirectedGraph

Returns a list of entry points for this graph.

Specified by:

getHeads in interface DirectedGraph

getTails

public java.util.List getTails()

Description copied from interface: DirectedGraph

Returns a list of exit points for this graph.

Specified by:

getTails in interface DirectedGraph

getPredsOf

public java.util.List getPredsOf(java.lang.Object s)

Description copied from interface: DirectedGraph

Returns a list of predecessors for the given node in the graph.

Specified by:

getPredsOf in interface DirectedGraph

getSuccsOf

public java.util.List getSuccsOf(java.lang.Object s)

Description copied from interface: DirectedGraph

Returns a list of successors for the given node in the graph.

Specified by:

getSuccsOf in interface DirectedGraph

size

public int size()

Description copied from interface: DirectedGraph

Returns the node count for this graph.

Specified by:

size in interface DirectedGraph

iterator

public java.util.Iterator iterator()

Description copied from interface: DirectedGraph

Returns an iterator for the nodes in this graph. No specific ordering of the nodes is guaranteed.

Specified by:

iterator in interface java.lang.Iterable

Specified by:

iterator in interface DirectedGraph

addEdge

public void addEdge(java.lang.Object from,
                    java.lang.Object to,
                    java.lang.Object label)

Description copied from interface: MutableEdgeLabelledDirectedGraph

Adds an edge to the graph between 2 nodes. If the edge is already present no change is made.

Specified by:

addEdge in interface MutableEdgeLabelledDirectedGraph

Parameters:

from - out node for the edge.

to - in node for the edge.

label - label for the edge.

getLabelsForEdges

public java.util.List<java.lang.Object> getLabelsForEdges(java.lang.Object from,
                                                          java.lang.Object to)

Description copied from interface: MutableEdgeLabelledDirectedGraph

Returns a list of labels for which an edge exists between from and to

Specified by:

getLabelsForEdges in interface MutableEdgeLabelledDirectedGraph

Parameters:

from - out node for the edges to remove.

to - in node for the edges to remove.

getEdgesForLabel

public MutableDirectedGraph getEdgesForLabel(java.lang.Object label)

Description copied from interface: MutableEdgeLabelledDirectedGraph

Returns a MutableDirectedGraph consisting of all edges with the given label and their nodes. Nodes without edges are not included in the new graph.

Specified by:

getEdgesForLabel in interface MutableEdgeLabelledDirectedGraph

Parameters:

label - label for the edge to remove.

removeEdge

public void removeEdge(java.lang.Object from,
                       java.lang.Object to,
                       java.lang.Object label)

Description copied from interface: MutableEdgeLabelledDirectedGraph

Removes an edge between 2 nodes in the graph. If the edge is not present no change is made.

Specified by:

removeEdge in interface MutableEdgeLabelledDirectedGraph

Parameters:

from - out node for the edges to remove.

to - in node for the edges to remove.

label - label for the edge to remove.

removeAllEdges

public void removeAllEdges(java.lang.Object from,
                           java.lang.Object to)

Description copied from interface: MutableEdgeLabelledDirectedGraph

Removes all edges between 2 nodes in the graph. If no edges are present, no change is made.

Specified by:

removeAllEdges in interface MutableEdgeLabelledDirectedGraph

Parameters:

from - out node for the edges to remove.

to - in node for the edges to remove.

removeAllEdges

public void removeAllEdges(java.lang.Object label)

Description copied from interface: MutableEdgeLabelledDirectedGraph

Removes all edges with the given label in the graph. If no edges are present, no change is made.

Specified by:

removeAllEdges in interface MutableEdgeLabelledDirectedGraph

Parameters:

label - label for the edge to remove.

containsEdge

public boolean containsEdge(java.lang.Object from,
                            java.lang.Object to,
                            java.lang.Object label)

Specified by:

containsEdge in interface MutableEdgeLabelledDirectedGraph

Returns:

true if the graph contains an edge between the 2 nodes with the given label, otherwise return false.

containsAnyEdge

public boolean containsAnyEdge(java.lang.Object from,
                               java.lang.Object to)

Specified by:

containsAnyEdge in interface MutableEdgeLabelledDirectedGraph

Parameters:

from - out node for the edges.

to - in node for the edges.

Returns:

true if the graph contains any edges between the 2 nodes, otherwise return false.

containsAnyEdge

public boolean containsAnyEdge(java.lang.Object label)

Specified by:

containsAnyEdge in interface MutableEdgeLabelledDirectedGraph

Parameters:

label - label for the edges.

Returns:

true if the graph contains any edges with the given label, otherwise return false.

containsNode

public boolean containsNode(java.lang.Object node)

Specified by:

containsNode in interface MutableEdgeLabelledDirectedGraph

Parameters:

node - node that we want to know if the graph constains.

Returns:

true if the graph contains the node. false otherwise.

getNodes

public java.util.List<java.lang.Object> getNodes()

Specified by:

getNodes in interface MutableEdgeLabelledDirectedGraph

Returns:

a list of the nodes that compose the graph. No ordering is implied.

addNode

public void addNode(java.lang.Object node)

Description copied from interface: MutableEdgeLabelledDirectedGraph

Adds a node to the graph. Initially the added node has no successors or predecessors. ; as a consequence it is considered both a head and tail for the graph.

Specified by:

addNode in interface MutableEdgeLabelledDirectedGraph

Parameters:

node - a node to add to the graph.

See Also:

DirectedGraph.getHeads(), DirectedGraph.getTails()

removeNode

public void removeNode(java.lang.Object node)

Description copied from interface: MutableEdgeLabelledDirectedGraph

Removes a node from the graph. If the node is not found in the graph, no change is made.

Specified by:

removeNode in interface MutableEdgeLabelledDirectedGraph

Parameters:

node - the node to be removed.

printGraph

public void printGraph()