dataflow.model

Class DataFlowNode

java.lang.Object

dataflow.model.NodeRepresenter<T>

dataflow.model.OwnedNode<com.github.javaparser.ast.Node>

dataflow.model.DataFlowNode

public class DataFlowNode
extends OwnedNode<com.github.javaparser.ast.Node>

A node inside the DataFlowGraph containing a JavaParser Node. The incoming DataFlowEdges are DataFlowNodes that influence the state of this node. The outgoing DataFlowEdges point to DataFlowNodes which state is influenced by this DataFlowNode.

Author:

Daan

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class dataflow.model.NodeRepresenter

name

Constructor Summary

Constructors

Constructor and Description
DataFlowNode(com.github.javaparser.ast.Node representedNode)
DataFlowNode(String name, com.github.javaparser.ast.Node representedNode)

Method Summary

Modifier and Type	Method and Description
void	addEdgeTo(DataFlowNode to)
static DataFlowNode.Builder	builder() Creates builder to build DataFlowNode.
boolean	equals(Object obj)
List<DataFlowEdge>	getIn()
List<DataFlowEdge>	getOut()
Optional<OwnedNode<?>>	getOwner()
String	getType()
boolean	hasAsDirectInput(DataFlowNode node)
int	hashCode()
boolean	isField()
boolean	isInputParameter()
void	setIn(List<DataFlowEdge> in)
void	setOut(List<DataFlowEdge> out)
void	setOwner(OwnedNode<?> owner)
void	setType(String type)
String	toString()
String	toStringBackward(int tabs)
String	toStringForward(int tabs)
String	toStringForward(int tabs, int firstTabs)
List<DataFlowNode>	walkBackUntil(java.util.function.Predicate<DataFlowNode> predicate, java.util.function.Predicate<DataFlowNode> scope) Walks back over incoming edges until predicate is met or no incoming edges are present.

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

DataFlowNode

public DataFlowNode(com.github.javaparser.ast.Node representedNode)

DataFlowNode

public DataFlowNode(String name,
                    com.github.javaparser.ast.Node representedNode)

Method Detail

getIn

public List<DataFlowEdge> getIn()

setIn

public void setIn(List<DataFlowEdge> in)

getOut

public List<DataFlowEdge> getOut()

setOut

public void setOut(List<DataFlowEdge> out)

addEdgeTo

public void addEdgeTo(DataFlowNode to)

getType

public String getType()

setType

public void setType(String type)

isField

public boolean isField()

isInputParameter

public boolean isInputParameter()

walkBackUntil

public List<DataFlowNode> walkBackUntil(java.util.function.Predicate<DataFlowNode> predicate,
                                        java.util.function.Predicate<DataFlowNode> scope)

Walks back over incoming edges until predicate is met or no incoming edges are present.

Parameters:

predicate - The Predicate to meet

scope - The scope for the variable, the search is stopped as soon as the scope does not hold and an empty list is returned.

Returns:

List of DataFlowNode

See Also:

GraphUtil.walkBackUntil(DataFlowNode, Predicate, Predicate)

hasAsDirectInput

public boolean hasAsDirectInput(DataFlowNode node)

Parameters:

node - The DataFlowNode to check.

Returns:

True if this node is equal to the given node or has a direct incoming edge from the input node, false otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class NodeRepresenter<com.github.javaparser.ast.Node>

equals

public boolean equals(Object obj)

Overrides:

equals in class NodeRepresenter<com.github.javaparser.ast.Node>

toString

public String toString()

Overrides:

toString in class NodeRepresenter<com.github.javaparser.ast.Node>

toStringForward

public String toStringForward(int tabs)

toStringForward

public String toStringForward(int tabs,
                              int firstTabs)

toStringBackward

public String toStringBackward(int tabs)

builder

public static DataFlowNode.Builder builder()

Creates builder to build DataFlowNode.

Returns:

created builder

getOwner

public Optional<OwnedNode<?>> getOwner()

Specified by:

getOwner in class OwnedNode<com.github.javaparser.ast.Node>

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.

setOwner

public void setOwner(OwnedNode<?> owner)