net.markenwerk.commons.iterators

Class NodeListIterator

java.lang.Object

net.markenwerk.commons.iterators.AbstractProtectedIterator<Payload>

net.markenwerk.commons.iterators.AbstractProtectedBidirectionalIterator<Payload>

net.markenwerk.commons.iterators.AbstractIndexedIterator<Node>

net.markenwerk.commons.iterators.NodeListIterator

All Implemented Interfaces:

Iterator<Node>, BidirectionalIterator<Node>, ProtectedBidirectionalIterator<Node>, ProtectedIterator<Node>

public final class NodeListIterator
extends AbstractIndexedIterator<Node>

A NodeListIterator is a AbstractIndexedIterator that iterates over a given NodeList.

Since:

3.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
NodeListIterator(NodeList nodeList) Creates a new NodeListIterator.

Method Summary

Modifier and Type	Method and Description
Node	get(int index) Returns the payload value at the given index.

Methods inherited from class net.markenwerk.commons.iterators.AbstractIndexedIterator

hasNext, hasPrevious, next, previous

Methods inherited from class net.markenwerk.commons.iterators.AbstractProtectedIterator

remove

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.markenwerk.commons.iterators.ProtectedBidirectionalIterator

remove

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

NodeListIterator

public NodeListIterator(NodeList nodeList)
                 throws IllegalArgumentException

Creates a new NodeListIterator.

Parameters:

nodeList - The NodeList to iterate over.

Throws:

IllegalArgumentException - If the given NodeList is null.

Method Detail

get

public Node get(int index)

Description copied from class: AbstractIndexedIterator

Returns the payload value at the given index.

Specified by:

get in class AbstractIndexedIterator<Node>

Parameters:

index - The index to be used, which is guaranteed to be non-negative and smaller then the maximum index.

Returns:

The payload value at the given index.