Node (javaparser-core 3.0.0-RC.1 API)

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

All Implemented Interfaces:

Observable, Visitable, HasParentNode<Node>, Cloneable

Direct Known Subclasses:

ArrayBracketPair, ArrayCreationLevel, BodyDeclaration, CatchClause, Comment, CompilationUnit, Expression, ImportDeclaration, MemberValuePair, Name, PackageDeclaration, Parameter, SimpleName, Statement, Type, VariableDeclarator, VariableDeclaratorId
```
public abstract class Node
extends Object
implements Cloneable, HasParentNode<Node>, Visitable
```
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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Node.ObserverRegistrationMode
Different registration mode for observers on nodes.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Node.ObserverRegistrationMode` Different registration mode for observers on nodes.

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.
`protected static PrettyPrinterConfiguration`	`prettyPrinterNoCommentsConfiguration`

Constructor Summary

Constructors
Constructor and Description

Node(Range range)

Constructors
Constructor and Description
`Node(Range range)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`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
`Optional<Position>`	`getBegin()` The begin position of this node in the source file.
`List<Node>`	`getChildNodes()` Contains all nodes that have this node set as their parent.
`Comment`	`getComment()` This is a comment associated with this node.
`<M> M`	`getData(DataKey<M> key)` Gets data for this component using the given key.
`Optional<Position>`	`getEnd()` The end position of this node in the source file.
`List<NodeList<?>>`	`getNodeLists()` The list of NodeLists owned by this node.
`<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.
`Optional<Node>`	`getParentNode()` Return the parent node or null, if no parent is set.
`Node`	`getParentNodeForChildren()` this for everything except NodeLists.
`Optional<Range>`	`getRange()`
`boolean`	`hasComment()`
`int`	`hashCode()`
`boolean`	`isPositionedAfter(Position position)` Deprecated.
`boolean`	`isPositionedBefore(Position position)` Deprecated.
`boolean`	`isRegistered(AstObserver observer)` Was this observer registered? Note that equals is used to determine if the given observer was registered.
`protected <P> void`	`notifyPropertyChange(ObservableProperty property, P oldValue, P newValue)`
`void`	`register(AstObserver observer)` Register an observer.
`void`	`register(AstObserver observer, Node.ObserverRegistrationMode mode)` Register a new observer for the given node.
`void`	`registerForSubtree(AstObserver observer)` Register the observer for the current node and all the contained node and nodelists, recursively.
`boolean`	`remove()` Try to remove this node from the parent
`protected void`	`setAsParentNodeOf(NodeList<? extends Node> list)`
`Node`	`setBlockComment(String comment)` Use this to store additional information to this node.
`Node`	`setComment(Comment comment)` Use this to store additional information to this node.
`<M> void`	`setData(DataKey<M> key, M object)` Sets data for this component using the given key.
`Node`	`setLineComment(String comment)` Use this to store additional information to this node.
`Node`	`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)`
`String`	`toString()` Return the String representation of this node.
`String`	`toString(PrettyPrinterConfiguration prettyPrinterConfiguration)`
`void`	`tryAddImportToParentCompilationUnit(Class<?> clazz)`
`void`	`unregister(AstObserver observer)` Unregister an observer.

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

Methods inherited from interface com.github.javaparser.HasParentNode
getAncestorOfType, setAsParentNodeOf, setAsParentNodeOf

Methods inherited from interface com.github.javaparser.ast.visitor.Visitable
accept, accept

- Field Detail
  - NODE_BY_BEGIN_POSITION
```
public static Comparator<Node> NODE_BY_BEGIN_POSITION
```
    This can be used to sort nodes on position.
  - prettyPrinterNoCommentsConfiguration
```
protected static final PrettyPrinterConfiguration prettyPrinterNoCommentsConfiguration
```
  - 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
  - getComment
```
public final Comment getComment()
```
    This is a comment associated with this node.
    
    Returns:
    
    comment property
  - getBegin
```
public Optional<Position> getBegin()
```
    The begin position of this node in the source file.
  - getEnd
```
public Optional<Position> getEnd()
```
    The end position of this node in the source file.
  - getRange
```
public Optional<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. null can be used to indicate that no range information is known, or that it is not of interest.
  - setComment
```
public final Node setComment(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
  - toString
```
public final String toString(PrettyPrinterConfiguration prettyPrinterConfiguration)
```
  - 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 Optional<Node> getParentNode()
```
    Description copied from interface: HasParentNode
    
    Return the parent node or null, if no parent is set.
    
    Specified by:
    
    getParentNode in interface HasParentNode<Node>
  - getChildNodes
```
public List<Node> getChildNodes()
```
    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.
  - 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 Node setParentNode(Node parentNode)
```
    Assign a new parent to this node, removing it from the list of children of the previous parent, if any.
    
    Specified by:
    
    setParentNode in interface HasParentNode<Node>
    
    Parameters:
    
    parentNode - node to be set as parent
    
    Returns:
    
    return this
  - isPositionedAfter
```
@Deprecated
public boolean isPositionedAfter(Position position)
```
    Deprecated.
  - isPositionedBefore
```
@Deprecated
public boolean isPositionedBefore(Position position)
```
    Deprecated.
  - hasComment
```
public boolean hasComment()
```
  - 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.
  - getData
```
public <M> M getData(DataKey<M> key)
```
    Gets data for this component using the given key.
    
    Type Parameters:
    
    M - The type of the data.
    
    Parameters:
    
    key - The key for the data
    
    Returns:
    
    The data or null of no data was found for the given key
    
    See Also:
    
    DataKey
  - setData
```
public <M> void setData(DataKey<M> key,
                        M object)
```
    Sets data for this component using the given key. For information on creating DataKey, see DataKey.
    
    Type Parameters:
    
    M - The type of data
    
    Parameters:
    
    key - The singleton key for the data
    
    object - The data object
    
    Throws:
    
    IllegalArgumentException
    
    See Also:
    
    DataKey
  - 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
  - getParentNodeForChildren
```
public Node getParentNodeForChildren()
```
    Description copied from interface: HasParentNode
    
    this for everything except NodeLists. NodeLists use their parent as their children parent.
    
    Specified by:
    
    getParentNodeForChildren in interface HasParentNode<Node>
  - setAsParentNodeOf
```
protected void setAsParentNodeOf(NodeList<? extends Node> list)
```
  - notifyPropertyChange
```
protected <P> void notifyPropertyChange(ObservableProperty property,
                                        P oldValue,
                                        P newValue)
```
  - unregister
```
public void unregister(AstObserver observer)
```
    Description copied from interface: Observable
    
    Unregister an observer. If the given observer was not registered there are no effects.
    
    Specified by:
    
    unregister in interface Observable
  - register
```
public void register(AstObserver observer)
```
    Description copied from interface: Observable
    
    Register an observer.
    
    Specified by:
    
    register in interface Observable
  - register
```
public void register(AstObserver observer,
                     Node.ObserverRegistrationMode mode)
```
    Register a new observer for the given node. Depending on the mode specified also descendants, existing and new, could be observed. For more details see ObserverRegistrationMode.
  - registerForSubtree
```
public void registerForSubtree(AstObserver observer)
```
    Register the observer for the current node and all the contained node and nodelists, recursively.
  - isRegistered
```
public boolean isRegistered(AstObserver observer)
```
    Description copied from interface: Observable
    
    Was this observer registered? Note that equals is used to determine if the given observer was registered.
    
    Specified by:
    
    isRegistered in interface Observable
  - getNodeLists
```
public List<NodeList<?>> getNodeLists()
```
    The list of NodeLists owned by this node.

Class Node

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.github.javaparser.HasParentNode

Methods inherited from interface com.github.javaparser.ast.visitor.Visitable

Field Detail

NODE_BY_BEGIN_POSITION

prettyPrinterNoCommentsConfiguration

ABSOLUTE_BEGIN_LINE

ABSOLUTE_END_LINE

Constructor Detail

Node

Method Detail

getComment

getBegin

getEnd

getRange

setRange

setComment

setLineComment

setBlockComment

toString

toString

hashCode

equals

clone

getParentNode

getChildNodes

containsWithin

addOrphanComment

getOrphanComments

getAllContainedComments

setParentNode

isPositionedAfter

isPositionedBefore

hasComment

tryAddImportToParentCompilationUnit

getNodesByType

getData

setData

remove

getParentNodeForChildren

setAsParentNodeOf

notifyPropertyChange

unregister

register

register

registerForSubtree

isRegistered

getNodeLists