Top Fields Constructors Methods
com.vladsch.flexmark.util.ast

public Class DescendantNodeIterator

extends Object
implements ReversiblePeekingIterator<Node>
Class Inheritance
All Implemented Interfaces
com.vladsch.flexmark.util.collection.iteration.ReversiblePeekingIterator, com.vladsch.flexmark.util.collection.iteration.ReversibleIterator, java.util.Iterator
Imports
com.vladsch.flexmark.util.collection.iteration.ReversiblePeekingIterator, org.jetbrains.annotations.NotNull, .Nullable, java.util.Stack, java.util.function.Consumer

Field Summary

Modifier and TypeField and Description
private final boolean
private @NotNull ReversiblePeekingIterator<Node>
private @Nullable Stack<ReversiblePeekingIterator<Node>>
private Node

Constructor Summary

AccessConstructor and Description
public
DescendantNodeIterator(@NotNull ReversiblePeekingIterator<Node>
iterator to use for iterating nodes and their descendants
iterator
)

iterate nodes, with descendants, depth first until all are done

Method Summary

Modifier and TypeMethod and Description
public void
forEachRemaining(@NotNull Consumer<? super Node>
The action to be performed for each element
consumer
)

Overrides default java.util.Iterator.forEachRemaining.

Performs the given action for each remaining element until all elements have been processed or the action throws an exception.

public boolean
hasNext()

Implements java.util.Iterator.hasNext.

Returns true if the iteration has more elements.

public boolean
public @NotNull Node
next()

Implements java.util.Iterator.next.

Returns the next element in the iteration.

public @Nullable Node
public void
remove()

Overrides default java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation).

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

isReversedback to summary
private final boolean isReversed
iteratorback to summary
private @NotNull ReversiblePeekingIterator<Node> iterator
Annotations
@NotNull
iteratorStackback to summary
private @Nullable Stack<ReversiblePeekingIterator<Node>> iteratorStack
Annotations
@Nullable
resultback to summary
private Node result

Constructor Detail

DescendantNodeIteratorback to summary
public DescendantNodeIterator(@NotNull ReversiblePeekingIterator<Node> iterator)

iterate nodes, with descendants, depth first until all are done

Parameters
iterator:@NotNull ReversiblePeekingIterator<Node>

iterator to use for iterating nodes and their descendants

Method Detail

forEachRemainingback to summary
public void forEachRemaining(@NotNull Consumer<? super Node> consumer)

Overrides default java.util.Iterator.forEachRemaining.

Doc from java.util.Iterator.forEachRemaining.

Performs the given action for each remaining element until all elements have been processed or the action throws an exception. Actions are performed in the order of iteration, if that order is specified. Exceptions thrown by the action are relayed to the caller.

The behavior of an iterator is unspecified if the action modifies the collection in any way (even by calling the remove method or other mutator methods of Iterator subtypes), unless an overriding class has specified a concurrent modification policy.

Subsequent behavior of an iterator is unspecified if the action throws an exception.

Parameters
consumer:@NotNull Consumer<? super Node>

The action to be performed for each element

hasNextback to summary
public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Returns:boolean

true if the iteration has more elements

Annotations
@Override
isReversedback to summary
public boolean isReversed()

Implements com.vladsch.flexmark.util.collection.iteration.ReversibleIterator.isReversed.

Annotations
@Override
nextback to summary
public @NotNull Node next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:@NotNull Node

the next element in the iteration

Annotations
@Override
@NotNull
peekback to summary
public @Nullable Node peek()

Implements com.vladsch.flexmark.util.collection.iteration.ReversiblePeekingIterator.peek.

Annotations
@Nullable
removeback to summary
public void remove()

Overrides default java.util.Iterator.remove.

Doc from java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next.

The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy.

The behavior of an iterator is unspecified if this method is called after a call to the forEachRemaining method.

Annotations
@Override