polyglot.ast

Interface Node

All Superinterfaces:

java.lang.Cloneable, Copy<Node>, NodeOps, java.io.Serializable

All Known Subinterfaces:

AmbAssign, AmbExpr, Ambiguous, AmbPrefix, AmbQualifierNode, AmbReceiver, AmbTypeNode, AnnotationElem, AnnotationElemDecl, ArrayAccess, ArrayAccessAssign, ArrayInit, ArrayTypeNode, Assert, Assign, Binary, Block, BooleanLit, Branch, Call, CanonicalTypeNode, Case, Cast, Catch, CharLit, ClassBody, ClassDecl, ClassLit, ClassMember, CodeBlock, CodeDecl, CodeNode, CompoundStmt, Conditional, ConstructorCall, ConstructorDecl, Do, ElementValueArrayInit, ElementValuePair, Empty, EnumConstant, EnumConstantDecl, Eval, Expr, ExtendedFor, Field, FieldAssign, FieldDecl, FloatLit, For, ForInit, Formal, ForUpdate, Id, If, Import, Initializer, Instanceof, IntLit, JL5Import, Labeled, Lit, Local, LocalAssign, LocalClassDecl, LocalDecl, Loop, MethodDecl, MultiCatch, NamedVariable, New, NewArray, NullLit, NumLit, PackageNode, ParamTypeNode, Prefix, ProcedureCall, ProcedureDecl, QualifierNode, Receiver, Return, SourceCollection, SourceFile, Special, Stmt, StringLit, Switch, SwitchBlock, SwitchElement, Synchronized, Term, Throw, TopLevelDecl, Try, TryWithResources, TypeNode, Unary, VarDecl, Variable, While

All Known Implementing Classes:

AbstractBlock_c, AmbAssign_c, AmbDiamondTypeNode, AmbExpr_c, AmbPrefix_c, AmbQualifierNode_c, AmbReceiver_c, AmbTypeInstantiation, AmbTypeNode_c, AmbUnionType, AmbWildCard, AnnotationElem_c, AnnotationElemDecl_c, ArrayAccess_c, ArrayAccessAssign_c, ArrayInit_c, ArrayTypeNode_c, Assert_c, Assign_c, Binary_c, Block_c, BooleanLit_c, Branch_c, Call_c, CanonicalTypeNode_c, Case_c, Cast_c, Catch_c, CharLit_c, ClassBody_c, ClassDecl_c, ClassLit_c, Conditional_c, ConstructorCall_c, ConstructorDecl_c, Do_c, ElementValueArrayInit_c, ElementValuePair_c, Empty_c, EnumConstant_c, EnumConstantDecl_c, Eval_c, Expr_c, ExtendedFor_c, Field_c, FieldAssign_c, FieldDecl_c, FloatLit_c, For_c, Formal_c, Id_c, If_c, Import_c, Initializer_c, Instanceof_c, IntLit_c, Labeled_c, Lit_c, Local_c, LocalAssign_c, LocalClassDecl_c, LocalDecl_c, Loop_c, Loop.Instance, MethodDecl_c, MultiCatch_c, New_c, NewArray_c, Node_c, NullLit_c, NumLit_c, PackageNode_c, ParamTypeNode_c, ProcedureDecl_c, Return_c, SourceCollection_c, SourceFile_c, Special_c, Stmt_c, StringLit_c, Switch_c, SwitchBlock_c, Synchronized_c, Term_c, Term.Instance, Throw_c, Try_c, TryWithResources_c, TypeNode_c, TypeNode.Instance, Unary_c, While_c

public interface Node
extends NodeOps, Copy<Node>, java.io.Serializable

A Node represents an AST node. All AST nodes must implement this interface. Nodes should be immutable: methods which set fields of the node should copy the node, set the field in the copy, and then return the copy.

Nested Class Summary

Nested classes/interfaces inherited from interface polyglot.util.Copy

Copy.Util

Method Summary

Methods

Modifier and Type	Method and Description
NodeOps	del() Deprecated.
Node	del(JLDel del) Deprecated.
void	dump(CodeWriter w) Dump the AST node for debugging purposes.
boolean	error() Return true if there an error in this node or its children.
Node	error(boolean flag)
Ext	ext() Get the node's extension.
Node	ext(Ext ext) Set the extension of the node.
Ext	ext(int n) Get the node's nth extension, n >= 1.
Node	ext(int n, Ext ext) Set the node's nth extension, n >= 1.
boolean	isDisambiguated()
boolean	isTypeChecked()
Position	position() Get the position of the node in the source file.
Node	position(Position position) Create a copy of the node with a new position.
Node	visit(NodeVisitor v) Visit the node.
Node	visitEdge(Node parent, NodeVisitor v) Deprecated. Call NodeOps.visitChild(Node, NodeVisitor) instead.

Methods inherited from interface polyglot.ast.NodeOps

addDecls, buildTypes, buildTypesEnter, checkConstants, childExpectedType, copy, copy, disambiguate, disambiguateEnter, disambiguateOverride, dump, dump, dump, dump, enterChildScope, enterScope, exceptionCheck, exceptionCheckEnter, extRewrite, extRewriteEnter, lang, prettyPrint, prettyPrint, prettyPrint, prettyPrint, prettyPrint, throwTypes, translate, typeCheck, typeCheckEnter, typeCheckOverride, visitChild, visitChildren, visitList

Methods inherited from interface polyglot.util.Copy

copy

Method Detail

del

@Deprecated
Node del(JLDel del)

Deprecated.

Set the delegate of the node.

del

@Deprecated
NodeOps del()

Deprecated.

Get the node's delegate.

ext

Node ext(Ext ext)

Set the extension of the node.

ext

Ext ext()

Get the node's extension.

ext

Node ext(int n,
       Ext ext)

Set the node's nth extension, n >= 1.

ext

Ext ext(int n)

Get the node's nth extension, n >= 1.

position

Position position()

Get the position of the node in the source file. Returns null if the position is not set.

position

Node position(Position position)

Create a copy of the node with a new position.

error

boolean error()

Return true if there an error in this node or its children.

error

Node error(boolean flag)

isDisambiguated

boolean isDisambiguated()

Returns:

true if the all type information for the node (but not necessarily for the node's children) is unambiguous.

isTypeChecked

boolean isTypeChecked()

Returns:

true if all the type information for the node (but not necessarily for the node's children) has been computed.

visit

Node visit(NodeVisitor v)

Visit the node. This method is equivalent to visitEdge(null, v).

Parameters:

v - The visitor which will traverse/rewrite the AST.

Returns:

A new AST if a change was made, or this.

visitEdge

@Deprecated
Node visitEdge(Node parent,
                        NodeVisitor v)

Deprecated. Call NodeOps.visitChild(Node, NodeVisitor) instead.

Visit the node, passing in the node's parent. This method is called by a NodeVisitor to traverse the AST starting at this node. This method should call the override, enter, and leave methods of the visitor. The method may return a new version of the node.

Parameters:

parent - The parent of this in the AST.

v - The visitor which will traverse/rewrite the AST.

Returns:

A new AST if a change was made, or this.

dump

void dump(CodeWriter w)

Dump the AST node for debugging purposes.