net.markenwerk.commons.iterables

Class NodeListIterable

java.lang.Object

net.markenwerk.commons.iterables.NodeListIterable

All Implemented Interfaces:

Iterable<Node>, BidirectionalIterable<Node>, ProtectedBidirectionalIterable<Node>

public final class NodeListIterable
extends Object
implements ProtectedBidirectionalIterable<Node>

A NodeListIterable is a ProtectedBidirectionalIterable that generates Iterators that iterate over a given NodeList.

Since:

3.1.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
NodeListIterator	iterator() Returns a ProtectedIterator.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

NodeListIterable

public NodeListIterable(NodeList nodeList)
                 throws IllegalArgumentException

Creates a new NodeListIterable.

Parameters:

nodeList - The NodeList to iterate over.

Throws:

IllegalArgumentException - If the given NodeList is null.

Method Detail

iterator

public NodeListIterator iterator()

Description copied from interface: ProtectedBidirectionalIterable

Returns a ProtectedIterator.

Specified by:

iterator in interface Iterable<Node>

Specified by:

iterator in interface BidirectionalIterable<Node>

Specified by:

iterator in interface ProtectedBidirectionalIterable<Node>

Returns:

A ProtectedIterator.