Node (javaparser-core 3.0.0-alpha.6 API)

java.lang.Object
- com.github.javaparser.ast.Node

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

ArrayBracketPair, ArrayCreationLevel, BodyDeclaration, CatchClause, Comment, CompilationUnit, Expression, ImportDeclaration, MemberValuePair, NodeList, PackageDeclaration, Parameter, Statement, Type, VariableDeclarator, VariableDeclaratorId
```
public abstract class Node
extends Object
implements Cloneable
```
Abstract class for all nodes of the AST. Each Node can have one associated comment which describe it and a number of "orphan comments" which it contains but are not specifically associated to any element.

Author:

Julio Vilmar Gesser

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ABSOLUTE_BEGIN_LINE`
`static int`	`ABSOLUTE_END_LINE`
`static Comparator<Node>`	`NODE_BY_BEGIN_POSITION` This can be used to sort nodes on position.

Constructor Summary

Constructors
Constructor and Description

Node(Range range)

Constructors
Constructor and Description
`Node(Range range)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`abstract <R,A> R`	`accept(GenericVisitor<R,A> v, A arg)` Accept method for visitor support.
`abstract <A> void`	`accept(VoidVisitor<A> v, A arg)` Accept method for visitor support.
`void`	`addOrphanComment(Comment comment)`
`Node`	`clone()`
`<N extends Node> boolean`	`containsWithin(N other)`
`boolean`	`equals(Object obj)`
`List<Comment>`	`getAllContainedComments()` This is the list of Comment which are contained in the Node either because they are properly associated to one of its children or because they are floating around inside the Node
`List<Node>`	`getBackwardsCompatibleChildrenNodes()` Deprecated. this will be gone in 3.0.0 release.
`Position`	`getBegin()` The begin position of this node in the source file.
`List<Node>`	`getChildrenNodes()` Contains all nodes that have this node set as their parent.
`Optional<? extends Comment>`	`getComment()` This is a comment associated with this node.
`Position`	`getEnd()` The end position of this node in the source file.
`<N extends Node> List<N>`	`getNodesByType(Class<N> clazz)` Recursively finds all nodes of a certain type.
`List<Comment>`	`getOrphanComments()` This is a list of Comment which are inside the node and are not associated with any meaningful AST Node.
`Node`	`getParentNode()`
`<T> T`	`getParentNodeOfType(Class<T> classType)`
`Range`	`getRange()`
`<M> M`	`getUserData(UserDataKey<M> key)` Gets user data for this component using the given key.
`int`	`hashCode()`
`boolean`	`isPositionedAfter(Position position)`
`boolean`	`isPositionedBefore(Position position)`
`boolean`	`remove()` Try to remove this node from the parent
`protected void`	`setAsParentNodeOf(List<? extends Node> childNodes)`
`protected void`	`setAsParentNodeOf(Node childNode)`
`protected void`	`setAsParentNodeOf(Optional<? extends Node> childNode)`
`Node`	`setBegin(Position begin)` Sets the begin position of this node in the source file.
`Node`	`setBlockComment(String comment)` Use this to store additional information to this node.
`Node`	`setComment(Optional<? extends Comment> comment)` Use this to store additional information to this node.
`Node`	`setEnd(Position end)` Sets the end position of this node in the source file.
`Node`	`setLineComment(String comment)` Use this to store additional information to this node.
`void`	`setParentNode(Node parentNode)` Assign a new parent to this node, removing it from the list of children of the previous parent, if any.
`Node`	`setRange(Range range)`
`<M> void`	`setUserData(UserDataKey<M> key, M object)` Sets user data for this component using the given key.
`String`	`toString()` Return the String representation of this node.
`String`	`toStringWithoutComments()`
`void`	`tryAddImportToParentCompilationUnit(Class<?> clazz)`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - NODE_BY_BEGIN_POSITION
```
public static Comparator<Node> NODE_BY_BEGIN_POSITION
```
    This can be used to sort nodes on position.
  - ABSOLUTE_BEGIN_LINE
```
public static final int ABSOLUTE_BEGIN_LINE
```
    See Also:
    
    Constant Field Values
  - ABSOLUTE_END_LINE
```
public static final int ABSOLUTE_END_LINE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Node
```
public Node(Range range)
```
- Method Detail
  - accept
```
public abstract <R,A> R accept(GenericVisitor<R,A> v,
                               A arg)
```
    Accept method for visitor support.
    
    Type Parameters:
    
    R - the type the return value of the visitor
    
    A - the type the argument passed to the visitor
    
    Parameters:
    
    v - the visitor implementation
    
    arg - the argument passed to the visitor
    
    Returns:
    
    the result of the visit
  - accept
```
public abstract <A> void accept(VoidVisitor<A> v,
                                A arg)
```
    Accept method for visitor support.
    
    Type Parameters:
    
    A - the type the argument passed for the visitor
    
    Parameters:
    
    v - the visitor implementation
    
    arg - any value relevant for the visitor
  - getComment
```
public Optional<? extends Comment> getComment()
```
    This is a comment associated with this node.
    
    Returns:
    
    comment property
  - getBegin
```
public Position getBegin()
```
    The begin position of this node in the source file.
  - getEnd
```
public Position getEnd()
```
    The end position of this node in the source file.
  - setBegin
```
public Node setBegin(Position begin)
```
    Sets the begin position of this node in the source file.
  - setEnd
```
public Node setEnd(Position end)
```
    Sets the end position of this node in the source file.
  - getRange
```
public Range getRange()
```
    Returns:
    
    the range of characters in the source code that this node covers.
  - setRange
```
public Node setRange(Range range)
```
    Parameters:
    
    range - the range of characters in the source code that this node covers.
  - setComment
```
public final Node setComment(Optional<? extends Comment> comment)
```
    Use this to store additional information to this node.
    
    Parameters:
    
    comment - to be set
  - setLineComment
```
public final Node setLineComment(String comment)
```
    Use this to store additional information to this node.
    
    Parameters:
    
    comment - to be set
  - setBlockComment
```
public final Node setBlockComment(String comment)
```
    Use this to store additional information to this node.
    
    Parameters:
    
    comment - to be set
  - toString
```
public final String toString()
```
    Return the String representation of this node.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the String representation of this node
  - toStringWithoutComments
```
public final String toStringWithoutComments()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - clone
```
public Node clone()
```
    Overrides:
    
    clone in class Object
  - getParentNode
```
public Node getParentNode()
```
  - getParentNodeOfType
```
public <T> T getParentNodeOfType(Class<T> classType)
```
  - getChildrenNodes
```
public List<Node> getChildrenNodes()
```
    Contains all nodes that have this node set as their parent. You can add nodes to it by setting a node's parent to this node. You can remove nodes from it by setting a child node's parent to something other than this node.
    
    Returns:
    
    all nodes that have this node as their parent.
  - getBackwardsCompatibleChildrenNodes
```
@Deprecated
public List<Node> getBackwardsCompatibleChildrenNodes()
```
    Deprecated. this will be gone in 3.0.0 release.
    
    Before 3.0.0.alpha-5, if we had a list of nodes, those nodes would not have the list as its parent, but the node containing the list. This method returns the children in that way: there are no lists, and all nodes that are in lists are directly in this list.
  - containsWithin
```
public <N extends Node> boolean containsWithin(N other)
```
  - addOrphanComment
```
public void addOrphanComment(Comment comment)
```
  - getOrphanComments
```
public List<Comment> getOrphanComments()
```
    This is a list of Comment which are inside the node and are not associated with any meaningful AST Node. For example, comments at the end of methods (immediately before the parenthesis) or at the end of CompilationUnit are orphan comments. When more than one comment preceeds a statement, the one immediately preceding it it is associated with the statements, while the others are orphans.
    
    Returns:
    
    all comments that cannot be attributed to a concept
  - getAllContainedComments
```
public List<Comment> getAllContainedComments()
```
    This is the list of Comment which are contained in the Node either because they are properly associated to one of its children or because they are floating around inside the Node
    
    Returns:
    
    all Comments within the node as a list
  - setParentNode
```
public void setParentNode(Node parentNode)
```
    Assign a new parent to this node, removing it from the list of children of the previous parent, if any.
    
    Parameters:
    
    parentNode - node to be set as parent
  - setAsParentNodeOf
```
protected void setAsParentNodeOf(List<? extends Node> childNodes)
```
  - setAsParentNodeOf
```
protected void setAsParentNodeOf(Node childNode)
```
  - setAsParentNodeOf
```
protected void setAsParentNodeOf(Optional<? extends Node> childNode)
```
  - isPositionedAfter
```
public boolean isPositionedAfter(Position position)
```
  - isPositionedBefore
```
public boolean isPositionedBefore(Position position)
```
  - tryAddImportToParentCompilationUnit
```
public void tryAddImportToParentCompilationUnit(Class<?> clazz)
```
  - getNodesByType
```
public <N extends Node> List<N> getNodesByType(Class<N> clazz)
```
    Recursively finds all nodes of a certain type.
    
    Parameters:
    
    clazz - the type of node to find.
  - getUserData
```
public <M> M getUserData(UserDataKey<M> key)
```
    Gets user data for this component using the given key.
    
    Type Parameters:
    
    M - The type of the user data.
    
    Parameters:
    
    key - The key for the data
    
    Returns:
    
    The user data or null of no user data was found for the given key
    
    See Also:
    
    UserDataKey
  - setUserData
```
public <M> void setUserData(UserDataKey<M> key,
                            M object)
```
    Sets user data for this component using the given key. For information on creating UserDataKey, see UserDataKey.
    
    Type Parameters:
    
    M - The type of user data
    
    Parameters:
    
    key - The singleton key for the user data
    
    object - The user data object
    
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    UserDataKey
  - remove
```
public boolean remove()
```
    Try to remove this node from the parent
    
    Returns:
    
    true if removed, false otherwise
    
    Throws:
    
    RuntimeException - if it fails in an unexpected way

Class Node

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NODE_BY_BEGIN_POSITION

ABSOLUTE_BEGIN_LINE

ABSOLUTE_END_LINE

Constructor Detail

Node

Method Detail

accept

accept

getComment

getBegin

getEnd

setBegin

setEnd

getRange

setRange

setComment

setLineComment

setBlockComment

toString

toStringWithoutComments

hashCode

equals

clone

getParentNode

getParentNodeOfType

getChildrenNodes

getBackwardsCompatibleChildrenNodes

containsWithin

addOrphanComment

getOrphanComments

getAllContainedComments

setParentNode

setAsParentNodeOf

setAsParentNodeOf

setAsParentNodeOf

isPositionedAfter

isPositionedBefore

tryAddImportToParentCompilationUnit

getNodesByType

getUserData

setUserData

remove