org.jaxen.util

Class AncestorOrSelfAxisIterator

java.lang.Object

org.jaxen.util.AncestorOrSelfAxisIterator

All Implemented Interfaces:

java.util.Iterator

Direct Known Subclasses:

AncestorAxisIterator

public class AncestorOrSelfAxisIterator
extends java.lang.Object
implements java.util.Iterator

Represents the XPath ancestor-or-self axis. The "ancestor-or-self axis contains the context node and the ancestors of the context node; thus, the ancestor axis will always include the root node."

Version:

1.2b12

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Object	contextNode
private Navigator	navigator

Constructor Summary

Constructors

Constructor and Description
AncestorOrSelfAxisIterator(java.lang.Object contextNode, Navigator navigator) Create a new ancestor-or-self axis iterator.

Method Summary

Modifier and Type	Method and Description
boolean	hasNext() Returns true if there are any nodes remaining on the ancestor-or-self axis; false otherwise.
java.lang.Object	next() Returns the next ancestor-or-self node.
void	remove() This operation is not supported.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Field Detail

contextNode

private java.lang.Object contextNode

navigator

private Navigator navigator

Constructor Detail

AncestorOrSelfAxisIterator

public AncestorOrSelfAxisIterator(java.lang.Object contextNode,
                                  Navigator navigator)

Create a new ancestor-or-self axis iterator.

Parameters:

contextNode - the node to start from

navigator - the object model specific navigator

Method Detail

hasNext

public boolean hasNext()

Returns true if there are any nodes remaining on the ancestor-or-self axis; false otherwise.

Specified by:

hasNext in interface java.util.Iterator

Returns:

true if any ancestors or self remain

See Also:

Iterator.hasNext()

next

public java.lang.Object next()

Returns the next ancestor-or-self node.

Specified by:

next in interface java.util.Iterator

Returns:

the next ancestor-or-self node

Throws:

java.util.NoSuchElementException - if no ancestors remain

See Also:

Iterator.next()

remove

public void remove()

This operation is not supported.

Specified by:

remove in interface java.util.Iterator

Throws:

java.lang.UnsupportedOperationException - always