Package com.github.javaparser.ast

Class NodeList<N extends Node>

java.lang.Object

com.github.javaparser.ast.NodeList<N>

Type Parameters:

N - the type of nodes contained.

All Implemented Interfaces:

Observable, Visitable, HasParentNode<NodeList<N>>, Iterable<N>, Collection<N>, List<N>, SequencedCollection<N>

public class NodeList<N extends Node>
extends Object
implements List<N>, Iterable<N>, HasParentNode<NodeList<N>>, Visitable, Observable

A list of nodes. It usually has a parent node. Unlike normal Nodes, this does not mean that it is a child of that parent. Instead, this list will make every node it contains a child of its parent. This way, a NodeList does not create an extra level inside the AST.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	NodeList.NodeListIterator

Field Summary

Fields

Modifier and Type	Field	Description
private final List<N>	innerList
private final List<AstObserver>	observers
private Node	parentNode

Constructor Summary

Constructors

Constructor	Description
NodeList()
NodeList(Collection<N> n)
NodeList(N... n)

Method Summary

Modifier and Type	Method	Description
<R, A> R	accept(GenericVisitor<R,A> v, A arg)	Accept method for visitor support.
<A> void	accept(VoidVisitor<A> v, A arg)	Accept method for visitor support.
void	add(int index, N node)
boolean	add(N node)
NodeList<N>	addAfter(N node, N afterThisNode)	Inserts the node after afterThisNode.
boolean	addAll(int index, Collection<? extends N> c)
void	addAll(NodeList<N> otherList)
boolean	addAll(Collection<? extends N> c)
NodeList<N>	addBefore(N node, N beforeThisNode)	Inserts the node before beforeThisNode.
void	addFirst(N node)	Inserts the node before all other nodes.
void	addLast(N node)	Inserts the node after all other nodes.
void	clear()
boolean	contains(Object o)
boolean	contains(N node)
boolean	containsAll(Collection<?> c)
boolean	equals(Object o)
void	forEach(Consumer<? super N> action)
N	get(int i)
N	getFirst()
N	getLast()
Optional<Node>	getParentNode()	Returns the parent node, or Optional.empty if no parent is set.
Node	getParentNodeForChildren()	Returns the parent node from the perspective of the children of this node.
int	hashCode()
void	ifNonEmpty(Consumer<? super NodeList<N>> consumer)
int	indexOf(Object o)
boolean	isEmpty()
boolean	isNonEmpty()
boolean	isRegistered(AstObserver observer)	Was this observer registered? Note that equals is used to determine if the given observer was registered.
Iterator<N>	iterator()
int	lastIndexOf(Object o)
ListIterator<N>	listIterator()
ListIterator<N>	listIterator(int index)
static <X extends Node> NodeList<X>	nodeList(NodeList<X> nodes)
static <X extends Node> NodeList<X>	nodeList(Collection<X> nodes)
static <X extends Node> NodeList<X>	nodeList(X... nodes)
private void	notifyElementAdded(int index, Node nodeAddedOrRemoved)
private void	notifyElementRemoved(int index, Node nodeAddedOrRemoved)
private void	notifyElementReplaced(int index, Node nodeAddedOrRemoved)
private void	own(N node)
Stream<N>	parallelStream()
void	register(AstObserver observer)	Register an observer.
N	remove(int index)
boolean	remove(Node node)
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
N	removeFirst()
boolean	removeIf(Predicate<? super N> filter)
N	removeLast()
boolean	replace(N old, N replacement)	Replaces the first node that is equal to "old" with "replacement".
void	replaceAll(UnaryOperator<N> operator)
boolean	retainAll(Collection<?> c)
N	set(int index, N element)
private void	setAsParentNodeOf(Node childNode)
private void	setAsParentNodeOf(List<? extends Node> childNodes)
NodeList<N>	setParentNode(Node parentNode)	Sets the parentNode
int	size()
void	sort(Comparator<? super N> comparator)
Spliterator<N>	spliterator()
List<N>	subList(int fromIndex, int toIndex)
Object[]	toArray()
<T> T[]	toArray(T[] a)
static <T extends Node> Collector<T,NodeList<T>,NodeList<T>>	toNodeList()
String	toString()
void	unregister(AstObserver observer)	Unregister an observer.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

stream, toArray

Methods inherited from interface com.github.javaparser.HasParentNode

findAncestor, findAncestor, findAncestor, hasParentNode, isDescendantOf

Methods inherited from interface java.util.List

reversed

Field Details

innerList

private final List<N extends Node> innerList

parentNode

private Node parentNode

observers

private final List<AstObserver> observers

Constructor Details

NodeList

public NodeList()

NodeList

public NodeList(Collection<N> n)

NodeList

@SafeVarargs
public NodeList(N... n)

Method Details

add

public boolean add(N node)

Specified by:

add in interface Collection<N extends Node>

Specified by:

add in interface List<N extends Node>

own

private void own(N node)

remove

public boolean remove(Node node)

removeFirst

public N removeFirst()

Specified by:

removeFirst in interface List<N extends Node>

Specified by:

removeFirst in interface SequencedCollection<N extends Node>

removeLast

public N removeLast()

Specified by:

removeLast in interface List<N extends Node>

Specified by:

removeLast in interface SequencedCollection<N extends Node>

nodeList

@SafeVarargs
public static <X extends Node> NodeList<X> nodeList(X... nodes)

nodeList

public static <X extends Node> NodeList<X> nodeList(Collection<X> nodes)

nodeList

public static <X extends Node> NodeList<X> nodeList(NodeList<X> nodes)

contains

public boolean contains(N node)

size

public int size()

Specified by:

size in interface Collection<N extends Node>

Specified by:

size in interface List<N extends Node>

get

public N get(int i)

Specified by:

get in interface List<N extends Node>

iterator

public Iterator<N> iterator()

Specified by:

iterator in interface Collection<N extends Node>

Specified by:

iterator in interface Iterable<N extends Node>

Specified by:

iterator in interface List<N extends Node>

set

public N set(int index,
 N element)

Specified by:

set in interface List<N extends Node>

remove

public N remove(int index)

Specified by:

remove in interface List<N extends Node>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<N extends Node>

Specified by:

isEmpty in interface List<N extends Node>

sort

public void sort(Comparator<? super N> comparator)

Specified by:

sort in interface List<N extends Node>

addAll

public void addAll(NodeList<N> otherList)

add

public void add(int index,
 N node)

Specified by:

add in interface List<N extends Node>

addFirst

public void addFirst(N node)

Inserts the node before all other nodes.

Specified by:

addFirst in interface List<N extends Node>

Specified by:

addFirst in interface SequencedCollection<N extends Node>

addLast

public void addLast(N node)

Inserts the node after all other nodes. (This is simply an alias for add.)

Specified by:

addLast in interface List<N extends Node>

Specified by:

addLast in interface SequencedCollection<N extends Node>

addAfter

public NodeList<N> addAfter(N node,
 N afterThisNode)

Inserts the node after afterThisNode.

Throws:

IllegalArgumentException - when afterThisNode is not in this list.

addBefore

public NodeList<N> addBefore(N node,
 N beforeThisNode)

Inserts the node before beforeThisNode.

Throws:

IllegalArgumentException - when beforeThisNode is not in this list.

getFirst

public N getFirst()

Specified by:

getFirst in interface List<N extends Node>

Specified by:

getFirst in interface SequencedCollection<N extends Node>

Returns:

the first node, or empty if the list is empty.

getLast

public N getLast()

Specified by:

getLast in interface List<N extends Node>

Specified by:

getLast in interface SequencedCollection<N extends Node>

Returns:

the last node, or empty if the list is empty.

getParentNode

public Optional<Node> getParentNode()

Description copied from interface: HasParentNode

Returns the parent node, or Optional.empty if no parent is set.

Specified by:

getParentNode in interface HasParentNode<N extends Node>

setParentNode

public NodeList<N> setParentNode(Node parentNode)

Sets the parentNode

Specified by:

setParentNode in interface HasParentNode<N extends Node>

Parameters:

parentNode - the parentNode

Returns:

this, the NodeList

getParentNodeForChildren

public Node getParentNodeForChildren()

Description copied from interface: HasParentNode

Returns the parent node from the perspective of the children of this node.

That is, this method returns this for everything except NodeList. A NodeList returns its parent node instead. This is because a NodeList sets the parent of all its children to its own parent node (see NodeList for details).

Specified by:

getParentNodeForChildren in interface HasParentNode<N extends Node>

accept

public <R,
A> R accept(GenericVisitor<R,A> v,
 A arg)

Description copied from interface: Visitable

Accept method for visitor support.

Specified by:

accept in interface Visitable

Type Parameters:

R - the type of the return value of the visitor

A - the type the user argument passed to the visitor

Parameters:

v - the visitor implementation

arg - the argument passed to the visitor (of type A)

Returns:

the result of the visit (of type R)

accept

public <A> void accept(VoidVisitor<A> v,
 A arg)

Description copied from interface: Visitable

Accept method for visitor support.

Specified by:

accept in interface Visitable

Type Parameters:

A - the type the argument passed for the visitor

Parameters:

v - the visitor implementation

arg - any value relevant for the visitor (of type A)

forEach

public void forEach(Consumer<? super N> action)

Specified by:

forEach in interface Iterable<N extends Node>

See Also:

• Iterable.forEach(java.util.function.Consumer)

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<N extends Node>

Specified by:

contains in interface List<N extends Node>

See Also:

• List.contains(java.lang.Object)

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<N extends Node>

Specified by:

toArray in interface List<N extends Node>

See Also:

• List.toArray()

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface Collection<N extends Node>

Specified by:

toArray in interface List<N extends Node>

See Also:

• List.toArray(java.lang.Object[])

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<N extends Node>

Specified by:

remove in interface List<N extends Node>

See Also:

• List.remove(java.lang.Object)

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<N extends Node>

Specified by:

containsAll in interface List<N extends Node>

See Also:

• List.containsAll(java.util.Collection)

addAll

public boolean addAll(Collection<? extends N> c)

Specified by:

addAll in interface Collection<N extends Node>

Specified by:

addAll in interface List<N extends Node>

See Also:

• List.addAll(java.util.Collection)

addAll

public boolean addAll(int index,
 Collection<? extends N> c)

Specified by:

addAll in interface List<N extends Node>

See Also:

• List.addAll(int, java.util.Collection)

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<N extends Node>

Specified by:

removeAll in interface List<N extends Node>

See Also:

• List.removeAll(java.util.Collection)

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<N extends Node>

Specified by:

retainAll in interface List<N extends Node>

See Also:

• List.retainAll(java.util.Collection)

replaceAll

public void replaceAll(UnaryOperator<N> operator)

Specified by:

replaceAll in interface List<N extends Node>

See Also:

• List.replaceAll(java.util.function.UnaryOperator)

removeIf

public boolean removeIf(Predicate<? super N> filter)

Specified by:

removeIf in interface Collection<N extends Node>

See Also:

• Collection.removeIf(java.util.function.Predicate)

clear

public void clear()

Specified by:

clear in interface Collection<N extends Node>

Specified by:

clear in interface List<N extends Node>

See Also:

• List.clear()

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<N extends Node>

Specified by:

equals in interface List<N extends Node>

Overrides:

equals in class Object

See Also:

• List.equals(java.lang.Object)

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<N extends Node>

Specified by:

hashCode in interface List<N extends Node>

Overrides:

hashCode in class Object

See Also:

• List.hashCode()

indexOf

public int indexOf(Object o)

Specified by:

indexOf in interface List<N extends Node>

See Also:

• List.indexOf(java.lang.Object)

lastIndexOf

public int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List<N extends Node>

See Also:

• List.lastIndexOf(java.lang.Object)

listIterator

public ListIterator<N> listIterator()

Specified by:

listIterator in interface List<N extends Node>

See Also:

• List.listIterator()

listIterator

public ListIterator<N> listIterator(int index)

Specified by:

listIterator in interface List<N extends Node>

See Also:

• List.listIterator(int)

parallelStream

public Stream<N> parallelStream()

Specified by:

parallelStream in interface Collection<N extends Node>

See Also:

• Collection.parallelStream()

subList

public List<N> subList(int fromIndex,
 int toIndex)

Specified by:

subList in interface List<N extends Node>

See Also:

• List.subList(int, int)

spliterator

public Spliterator<N> spliterator()

Specified by:

spliterator in interface Collection<N extends Node>

Specified by:

spliterator in interface Iterable<N extends Node>

Specified by:

spliterator in interface List<N extends Node>

See Also:

• List.spliterator()

notifyElementAdded

private void notifyElementAdded(int index,
 Node nodeAddedOrRemoved)

notifyElementRemoved

private void notifyElementRemoved(int index,
 Node nodeAddedOrRemoved)

notifyElementReplaced

private void notifyElementReplaced(int index,
 Node nodeAddedOrRemoved)

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

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

replace

public boolean replace(N old,
 N replacement)

Replaces the first node that is equal to "old" with "replacement".

Returns:

true if a replacement has happened.

isNonEmpty

public boolean isNonEmpty()

Returns:

the opposite of isEmpty()

ifNonEmpty

public void ifNonEmpty(Consumer<? super NodeList<N>> consumer)

toNodeList

public static <T extends Node>
Collector<T,NodeList<T>,NodeList<T>> toNodeList()

setAsParentNodeOf

private void setAsParentNodeOf(List<? extends Node> childNodes)

setAsParentNodeOf

private void setAsParentNodeOf(Node childNode)

toString

public String toString()

Overrides:

toString in class Object