public abstract class TextLinesIterator extends java.lang.Object implements SequenceIterator
StringValue
Modifier and Type | Field and Description |
---|---|
protected IntPredicateProxy |
checker |
protected Location |
location |
protected java.io.LineNumberReader |
reader |
protected java.net.URI |
uri |
Modifier | Constructor and Description |
---|---|
protected |
TextLinesIterator() |
|
TextLinesIterator(java.io.LineNumberReader reader,
Location location,
java.net.URI uri,
IntPredicateProxy checker)
Create a TextLinesIterator over a given reader
|
Modifier and Type | Method and Description |
---|---|
void |
close()
Close the iterator.
|
void |
discharge()
Calling this method instructs the iterator to release any resources it holds, while still
remaining able to deliver the remaining items in the sequence.
|
protected XPathException |
handleIOError(java.net.URI uri,
java.io.IOException err) |
StringValue |
next()
Get the next item in the sequence.
|
protected java.io.LineNumberReader reader
protected IntPredicateProxy checker
protected Location location
protected java.net.URI uri
protected TextLinesIterator()
public TextLinesIterator(java.io.LineNumberReader reader, Location location, java.net.URI uri, IntPredicateProxy checker) throws XPathException
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 diagnosticsXPathException
- if a dynamic error occurspublic StringValue next()
SequenceIterator
next
in interface SequenceIterator
protected XPathException handleIOError(java.net.URI uri, java.io.IOException err)
public void close()
SequenceIterator
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.
Closing an iterator is not necessary if the iterator is read to completion: if a call
on SequenceIterator.next()
returns null, the iterator will be closed automatically. An explicit
call on SequenceIterator.close()
is needed only when iteration is abandoned prematurely.
close
in interface java.io.Closeable
close
in interface java.lang.AutoCloseable
close
in interface SequenceIterator
public void discharge()
SequenceIterator
SequenceIterator.close()
will be called when no more items are needed.discharge
in interface SequenceIterator
Copyright (c) 2004-2022 Saxonica Limited. All rights reserved.