net.sf.saxon.tree.iter

Class TextLinesIterator

java.lang.Object

net.sf.saxon.tree.iter.TextLinesIterator

All Implemented Interfaces:

Closeable, AutoCloseable, SequenceIterator<StringValue>

Direct Known Subclasses:

UnparsedTextIterator

public abstract class TextLinesIterator
extends Object
implements SequenceIterator<StringValue>

An iterator that iterates over a file line by line. It is abstract because it does not supply the getAnother() method

Field Summary

Fields

Modifier and Type	Field and Description
protected IntPredicate	checker
(package private) StringValue	current
protected Location	location
(package private) int	position
protected LineNumberReader	reader
protected URI	uri

Fields inherited from interface net.sf.saxon.om.SequenceIterator

ATOMIZING, GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TextLinesIterator()
	TextLinesIterator(LineNumberReader reader, Location location, URI uri, IntPredicate checker) Create a TextLinesIterator over a given reader

Method Summary

Modifier and Type	Method and Description
void	close() Close the iterator.
StringValue	next() Get the next item in the sequence.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.saxon.om.SequenceIterator

forEachOrFail, getProperties, materialize

Field Detail

reader

protected LineNumberReader reader

checker

protected IntPredicate checker

current

StringValue current

position

int position

location

protected Location location

uri

protected URI uri

Constructor Detail

TextLinesIterator

protected TextLinesIterator()

TextLinesIterator

public TextLinesIterator(LineNumberReader reader,
                         Location location,
                         URI uri,
                         IntPredicate checker)
                  throws XPathException

Create a TextLinesIterator over a given reader

Parameters:

reader - the reader that reads the file

checker - checks that the characters in the file are legal XML characters

location - the location of the instruction being executed, for diagnostics. May be null.

uri - the URI of the file being read, for diagnostics

Throws:

XPathException - if a dynamic error occurs

Method Detail

next

public StringValue next()
                 throws XPathException

Description copied from interface: SequenceIterator

Get the next item in the sequence. This method changes the state of the iterator.

Specified by:

next in interface SequenceIterator<StringValue>

Returns:

the next item, or null if there are no more items. Once a call on next() has returned null, no further calls should be made. The preferred action for an iterator if subsequent calls on next() are made is to return null again, and all implementations within Saxon follow this rule.

Throws:

XPathException - if an error occurs retrieving the next item

close

public void close()

Description copied from interface: SequenceIterator

Close the iterator. This indicates to the supplier of the data that the client does not require any more items to be delivered by the iterator. This may enable the supplier to release resources. After calling close(), no further calls on the iterator should be made; if further calls are made, the effect of such calls is undefined.

For example, the iterator returned by the unparsed-text-lines() function has a close() method that causes the underlying input stream to be closed, whether or not the file has been read to completion.

Closing an iterator is important when the data is being "pushed" in another thread. Closing the iterator terminates that thread and means that it needs to do no additional work. Indeed, failing to close the iterator may cause the push thread to hang waiting for the buffer to be emptied.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SequenceIterator<StringValue>