flexmark-all 0.64.8 · com.vladsch.flexmark.util.ast.NodeIterator

Modifier and Type	Field and Description
public static final ReversiblePeekingIterator<Node>	EMPTY
pack-priv final Node	firstNode
pack-priv final Node	lastNode
pack-priv Node	node
pack-priv Node	result
pack-priv final boolean	reversed

Constructor Summary

Access	Constructor and Description
public	NodeIterator(Node node from which to start the iteration and continue until all sibling nodes have been traversed firstNode)
public	NodeIterator(Node node from which to start the iteration and continue until all sibling nodes have been traversed firstNode, boolean true/false if the nodes are to be traversed in reverse order. If true the nodes previous sibling will be used instead of next sibling reversed)
public	NodeIterator(Node node from which to start the iteration and continue until all sibling nodes have been traversed or lastNode has been traversed firstNode, Node the last node to be traversed lastNode)
public	NodeIterator(Node node from which to start the iteration and continue until all sibling nodes have been traversed or lastNode has been traversed firstNode, Node the last node to be traversed lastNode, boolean true/false if the nodes are to be traversed in reverse order. If true the nodes previous sibling will be used instead of next sibling reversed) iterate nodes until null or last node is iterated over

Method Summary

Modifier and Type	Method and Description
public void	forEachRemaining(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	Returns: true if there is a next node hasNext() Implements java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
public boolean	Returns: true if the iterator is a reversed iterator isReversed() Implements com.vladsch.flexmark.util.collection.iteration.ReversibleIterator.isReversed.
public Node	Returns: the next node for the iterator. If the iterator is not reversed then the previous node's next sibling is returned. If it is reversed the the previous node's previous sibling is returned. next() Implements java.util.Iterator.next. Returns the next element in the iteration.
public @Nullable Node	Returns: the node which would be returned by a call to `next()` or null if there is no next node. peek() Implements com.vladsch.flexmark.util.collection.iteration.ReversiblePeekingIterator.peek.
public void	remove() Overrides default java.util.Iterator.remove. Remove the last node returned by `next()`

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

EMPTY	back to summary
public static final ReversiblePeekingIterator<Node> EMPTY

firstNode	back to summary
pack-priv final Node firstNode

lastNode	back to summary
pack-priv final Node lastNode

node	back to summary
pack-priv Node node

result	back to summary
pack-priv Node result

reversed	back to summary
pack-priv final boolean reversed

Constructor Detail

NodeIterator	back to summary
public NodeIterator(Node firstNode) Parameters firstNode:Node node from which to start the iteration and continue until all sibling nodes have been traversed

NodeIterator	back to summary
public NodeIterator(Node firstNode, boolean reversed) Parameters firstNode:Node node from which to start the iteration and continue until all sibling nodes have been traversed reversed:boolean true/false if the nodes are to be traversed in reverse order. If true the nodes previous sibling will be used instead of next sibling

NodeIterator	back to summary
public NodeIterator(Node firstNode, Node lastNode) Parameters firstNode:Node node from which to start the iteration and continue until all sibling nodes have been traversed or lastNode has been traversed lastNode:Node the last node to be traversed

NodeIterator	back to summary
public NodeIterator(Node firstNode, Node lastNode, boolean reversed) iterate nodes until null or last node is iterated over Parameters firstNode:Node node from which to start the iteration and continue until all sibling nodes have been traversed or lastNode has been traversed lastNode:Node the last node to be traversed reversed:boolean true/false if the nodes are to be traversed in reverse order. If true the nodes previous sibling will be used instead of next sibling

NodeIterator

back to summary

public NodeIterator(Node firstNode, Node lastNode, boolean reversed)

iterate nodes until null or last node is iterated over

Parameters

firstNode:Node: node from which to start the iteration and continue until all sibling nodes have been traversed or lastNode has been traversed
lastNode:Node: the last node to be traversed
reversed:boolean: true/false if the nodes are to be traversed in reverse order. If true the nodes previous sibling will be used instead of next sibling

Method Detail

forEachRemaining back to summary

forEachRemaining	back to summary
public void forEachRemaining(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:Consumer<? super Node> The action to be performed for each element

public void forEachRemaining(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:Consumer<? super Node>: The action to be performed for each element

hasNext back to summary

hasNext	back 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 there is a next node Annotations @Override

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 there is a next node

Annotations

@Override

isReversed	back to summary
public boolean isReversed() Implements com.vladsch.flexmark.util.collection.iteration.ReversibleIterator.isReversed. Returns:boolean true if the iterator is a reversed iterator Annotations @Override

isReversed

back to summary

public boolean isReversed()

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

Returns:boolean

true if the iterator is a reversed iterator

Annotations

@Override

next	back to summary
public Node next() Implements java.util.Iterator.next. Doc from java.util.Iterator.next. Returns the next element in the iteration. Returns:Node the next node for the iterator. If the iterator is not reversed then the previous node's next sibling is returned. If it is reversed the the previous node's previous sibling is returned. Annotations @Override

back to summary

public Node next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:Node

the next node for the iterator. If the iterator is not reversed then the previous node's next sibling is returned. If it is reversed the the previous node's previous sibling is returned.

Annotations

@Override

peek back to summary

peek	back to summary
public @Nullable Node peek() Implements com.vladsch.flexmark.util.collection.iteration.ReversiblePeekingIterator.peek. Returns:@Nullable Node the node which would be returned by a call to `next()` or null if there is no next node. Annotations @Nullable

public @Nullable Node peek()

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

Returns:@Nullable Node

the node which would be returned by a call to next() or null if there is no next node.

Annotations