public class JTokenIterator extends java.lang.Object implements SequenceIterator<StringValue>
ATOMIZING, GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD
Constructor and Description |
---|
JTokenIterator(java.lang.CharSequence input,
java.util.regex.Pattern pattern)
Construct a JTokenIterator.
|
Modifier and Type | Method and Description |
---|---|
void |
close()
Close the iterator.
|
int |
getProperties()
Get properties of this iterator, as a bit-significant integer.
|
StringValue |
next()
Get the next item in the sequence.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
forEachOrFail, materialize
public JTokenIterator(java.lang.CharSequence input, java.util.regex.Pattern pattern)
public StringValue next()
SequenceIterator
next
in interface SequenceIterator<StringValue>
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.
close
in interface java.io.Closeable
close
in interface java.lang.AutoCloseable
close
in interface SequenceIterator<StringValue>
public int getProperties()
getProperties
in interface SequenceIterator<StringValue>
SequenceIterator.GROUNDED
, SequenceIterator.LAST_POSITION_FINDER
,
and SequenceIterator.LOOKAHEAD
. It is always
acceptable to return the value zero, indicating that there are no known special properties.
It is acceptable for the properties of the iterator to change depending on its state.Copyright (c) 2004-2020 Saxonica Limited. All rights reserved.