Package org.checkerframework.dataflow.cfg.node

Class MarkerNode

java.lang.Object

org.checkerframework.dataflow.cfg.node.Node

org.checkerframework.dataflow.cfg.node.MarkerNode

All Implemented Interfaces:

org.plumelib.util.UniqueId

Direct Known Subclasses:

CatchMarkerNode

public class MarkerNode
extends Node

MarkerNodes are no-op Nodes used for debugging information. They can hold a Tree and a message, which will be part of the String representation of the MarkerNode.

An example use case for MarkerNodes is representing switch statements.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	message
protected @Nullable com.sun.source.tree.Tree	tree

Fields inherited from class org.checkerframework.dataflow.cfg.node.Node

block, inSource, lvalue, type

Constructor Summary

Constructors

Constructor	Description
MarkerNode(@Nullable com.sun.source.tree.Tree tree, java.lang.String message, javax.lang.model.util.Types types)

Method Summary

Modifier and Type	Method	Description
<R,P> R	accept(NodeVisitor<R,P> visitor, P p)	Accept method of the visitor pattern.
boolean	equals(@Nullable java.lang.Object obj)
java.lang.String	getMessage()
java.util.Collection<Node>	getOperands()	Returns a collection containing all of the operand Nodes of this Node.
@Nullable com.sun.source.tree.Tree	getTree()	Returns the Tree in the abstract syntax tree, or null if no corresponding tree exists.
int	hashCode()
java.lang.String	toString()

Methods inherited from class org.checkerframework.dataflow.cfg.node.Node

getBlock, getInSource, getTransitiveOperands, getType, getUid, isLValue, nodeCollectionToString, setBlock, setInSource, setLValue, toStringDebug

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.plumelib.util.UniqueId

getClassAndUid

Field Detail

tree

protected final @Nullable com.sun.source.tree.Tree tree

message

protected final java.lang.String message

Constructor Detail

MarkerNode

public MarkerNode(@Nullable com.sun.source.tree.Tree tree,
                  java.lang.String message,
                  javax.lang.model.util.Types types)

Method Detail

getMessage

public java.lang.String getMessage()

getTree

public @Nullable com.sun.source.tree.Tree getTree()

Description copied from class: Node

Returns the Tree in the abstract syntax tree, or null if no corresponding tree exists. For instance, this is the case for an ImplicitThisNode.

Specified by:

getTree in class Node

Returns:

the corresponding Tree or null

accept

public <R,P> R accept(NodeVisitor<R,P> visitor,
                            P p)

Description copied from class: Node

Accept method of the visitor pattern.

Specified by:

accept in class Node

Type Parameters:

R - result type of the operation

P - parameter type

Parameters:

visitor - the visitor to be applied to this node

p - the parameter for this operation

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(@Nullable java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getOperands

@SideEffectFree
public java.util.Collection<Node> getOperands()

Description copied from class: Node

Returns a collection containing all of the operand Nodes of this Node.

Specified by:

getOperands in class Node

Returns:

a collection containing all of the operand Nodes of this Node