public final class CardinalityCheckingIterator extends java.lang.Object implements SequenceIterator
SequenceIterator.Property
Constructor and Description |
---|
CardinalityCheckingIterator(SequenceIterator base,
int requiredCardinality,
RoleDiagnostic role,
Location locator)
Construct an CardinalityCheckingIterator that will return the same items as the base sequence,
checking how many there are
|
Modifier and Type | Method and Description |
---|---|
void |
close()
Close the iterator.
|
Item |
next()
Get the next item in the sequence.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
forEachOrFail, getProperties, materialize
public CardinalityCheckingIterator(SequenceIterator base, int requiredCardinality, RoleDiagnostic role, Location locator) throws XPathException
base
- the base iteratorrequiredCardinality
- the required Cardinalityrole
- information for use if a failure occurslocator
- the location in the source stylesheet or queryXPathException
- if a failure is detectedpublic Item next() throws XPathException
SequenceIterator
next
in interface SequenceIterator
XPathException
- if an error occurs retrieving the next itempublic 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
Copyright (c) 2004-2020 Saxonica Limited. All rights reserved.