Package org.basex.query.iter

Class NodeIter

java.lang.Object

org.basex.query.iter.Iter

org.basex.query.iter.NodeIter

Direct Known Subclasses:

BasicNodeIter

public abstract class NodeIter
extends Iter

ANode iterator interface.

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

Constructor Summary

Constructors

Constructor	Description
NodeIter()

Method Summary

Modifier and Type	Method	Description
ANode	get(long i)	Returns the specified item, or an arbitrary item if the index is invalid.
abstract ANode	next()	Returns the next item.
long	size()	Returns the iterator size.

Methods inherited from class org.basex.query.iter.Iter

iterValue, value

Methods inherited from class java.lang.Object

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

Constructor Details

NodeIter

public NodeIter()

Method Details

next

public abstract ANode next()
                    throws QueryException

Description copied from class: Iter

Returns the next item.

Specified by:

next in class Iter

Returns:

resulting item, or null if all items have been returned

Throws:

QueryException - query exception

get

public ANode get(long i)

Description copied from class: Iter

Returns the specified item, or an arbitrary item if the index is invalid. If this method returns items, Iter.size() needs to be implemented as well.

Overrides:

get in class Iter

Parameters:

i - value offset (starting with 0)

Returns:

specified item or null

size

public long size()

Description copied from class: Iter

Returns the iterator size. -1 is returned if the result size is unknown. If this method returns a positive value, Iter.get(long) needs to be implemented as well.

Overrides:

size in class Iter

Returns:

number of entries