dataflow.model

Class DataFlowMethod

java.lang.Object

dataflow.model.NodeRepresenter<T>

dataflow.model.OwnedNode<T>

dataflow.model.OwnerNode<com.github.javaparser.ast.body.CallableDeclaration<?>>

dataflow.model.DataFlowMethod

public class DataFlowMethod
extends OwnerNode<com.github.javaparser.ast.body.CallableDeclaration<?>>

DataFlow class representing a method inside a DataFlowGraph.

Author:

Daan

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataFlowMethod.Builder Builder to build DataFlowMethod.

Field Summary

Fields inherited from class dataflow.model.NodeRepresenter

name

Constructor Summary

Constructors

Modifier	Constructor and Description
	DataFlowMethod(DataFlowGraph graph, com.github.javaparser.ast.body.CallableDeclaration<?> node, String name)
protected	DataFlowMethod(DataFlowMethod.Builder builder)
	DataFlowMethod(String name, com.github.javaparser.ast.body.CallableDeclaration<?> representedNode)

Method Summary

Modifier and Type	Method and Description
void	addChangedField(DataFlowNode node)
void	addChangedFields(DataFlowNode... fields)
void	addMethodCall(NodeCall calledMethod)
void	addNode(DataFlowNode created)
void	addNodes(List<DataFlowNode> nodes)
void	addParameter(DataFlowNode node)
static DataFlowMethod.Builder	builder() Creates builder to build DataFlowMethod.
boolean	equals(Object obj)
List<DataFlowNode>	getChangedFields()
List<DataFlowNode>	getDirectInputNodesFor(DataFlowNode node) Get's all nodes that are directly connected with an edge to (not from) the input node, which are in scope of this method.
Collection<DataFlowNode>	getDirectOwnedNodes()
DataFlowGraph	getGraph()
List<DataFlowNode>	getInputFields()
ParameterList	getInputParameters()
DataFlowNode	getNode(com.github.javaparser.ast.Node node)
List<NodeCall>	getNodeCalls()
Collection<DataFlowNode>	getNodes()
Set<OwnerNode<?>>	getOwnedOwners()
Optional<OwnedNode<?>>	getOwner()
Optional<DataFlowNode>	getReturnNode()
int	hashCode()
boolean	isInputBoundary(DataFlowNode n)
void	setCalledMethods(List<NodeCall> calledMethods)
void	setChangedFields(List<DataFlowNode> changedFields)
void	setGraph(DataFlowGraph graph)
void	setInputFields(List<DataFlowNode> inputFields)
void	setInputParameters(ParameterList inputParameters)
void	setReturnNode(DataFlowNode returnNode)
String	toString()

Methods inherited from class dataflow.model.OwnerNode

getOwnedNodes, owns

Methods inherited from class dataflow.model.NodeRepresenter

getName, getRepresentedNode, setName, setRepresentedNode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DataFlowMethod

public DataFlowMethod(String name,
                      com.github.javaparser.ast.body.CallableDeclaration<?> representedNode)

DataFlowMethod

public DataFlowMethod(DataFlowGraph graph,
                      com.github.javaparser.ast.body.CallableDeclaration<?> node,
                      String name)

DataFlowMethod

protected DataFlowMethod(DataFlowMethod.Builder builder)

Method Detail

getReturnNode

public Optional<DataFlowNode> getReturnNode()

setReturnNode

public final void setReturnNode(DataFlowNode returnNode)

getInputParameters

public ParameterList getInputParameters()

setInputParameters

public final void setInputParameters(ParameterList inputParameters)

getInputFields

public List<DataFlowNode> getInputFields()

setInputFields

public void setInputFields(List<DataFlowNode> inputFields)

getChangedFields

public List<DataFlowNode> getChangedFields()

setChangedFields

public void setChangedFields(List<DataFlowNode> changedFields)

getOwner

public Optional<OwnedNode<?>> getOwner()

Specified by:

getOwner in class OwnedNode<com.github.javaparser.ast.body.CallableDeclaration<?>>

Returns:

An optional of the OwnedNode of this node. The optional will be empty in case of a DataFlowGraph representing a non inner class or a method for which the rest of the graph was not parsed.

getGraph

public DataFlowGraph getGraph()

setGraph

public void setGraph(DataFlowGraph graph)

getNodes

public Collection<DataFlowNode> getNodes()

addNodes

public final void addNodes(List<DataFlowNode> nodes)

addNode

public final void addNode(DataFlowNode created)

getNode

public DataFlowNode getNode(com.github.javaparser.ast.Node node)

addParameter

public void addParameter(DataFlowNode node)

addChangedField

public void addChangedField(DataFlowNode node)

addChangedFields

public void addChangedFields(DataFlowNode... fields)

getNodeCalls

public List<NodeCall> getNodeCalls()

Returns:

List of DataFlowMethods containing both the input and output methods.

setCalledMethods

public void setCalledMethods(List<NodeCall> calledMethods)

addMethodCall

public void addMethodCall(NodeCall calledMethod)

getOwnedOwners

public Set<OwnerNode<?>> getOwnedOwners()

Returns:

all nodes directly owned by this OwnerNode for which it holds that

getDirectOwnedNodes

public Collection<DataFlowNode> getDirectOwnedNodes()

Returns:

all DataFlowNodes directly owned by this OwnerNode.

isInputBoundary

public boolean isInputBoundary(DataFlowNode n)

getDirectInputNodesFor

public List<DataFlowNode> getDirectInputNodesFor(DataFlowNode node)

Get's all nodes that are directly connected with an edge to (not from) the input node, which are in scope of this method.

Parameters:

node - The node to get the direct input nodes for.

Returns:

The list of DataFlowNode

toString

public String toString()

Overrides:

toString in class NodeRepresenter<com.github.javaparser.ast.body.CallableDeclaration<?>>

builder

public static DataFlowMethod.Builder builder()

Creates builder to build DataFlowMethod.

Returns:

created builder

hashCode

public int hashCode()

Overrides:

hashCode in class NodeRepresenter<com.github.javaparser.ast.body.CallableDeclaration<?>>

equals

public boolean equals(Object obj)

Overrides:

equals in class NodeRepresenter<com.github.javaparser.ast.body.CallableDeclaration<?>>