Package net.sf.saxon.tree.iter
Class TextLinesIterator
java.lang.Object
net.sf.saxon.tree.iter.TextLinesIterator
- All Implemented Interfaces:
Closeable
,AutoCloseable
,SequenceIterator
- Direct Known Subclasses:
UnparsedTextIterator
An iterator that iterates over a file line by line, returning each line as a
StringValue
-
Nested Class Summary
Nested classes/interfaces inherited from interface net.sf.saxon.om.SequenceIterator
SequenceIterator.Property
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected IntPredicate
(package private) StringValue
protected Location
(package private) int
protected LineNumberReader
protected URI
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
TextLinesIterator
(LineNumberReader reader, Location location, URI uri, IntPredicate checker) Create a TextLinesIterator over a given reader -
Method Summary
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 Details
-
reader
-
checker
-
current
StringValue current -
position
int position -
location
-
uri
-
-
Constructor Details
-
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 filechecker
- checks that the characters in the file are legal XML characterslocation
- 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 Details
-
next
Description copied from interface:SequenceIterator
Get the next item in the sequence. This method changes the state of the iterator.- Specified by:
next
in interfaceSequenceIterator
- 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 interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in interfaceSequenceIterator
-