ManualIterator

java.lang.Object
- net.sf.saxon.tree.iter.ManualIterator

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, LastPositionFinder, FocusIterator, SequenceIterator, GroundedIterator, LookaheadIterator, ReversibleIterator

Direct Known Subclasses:

com.saxonica.ee.stream.ManualGroupIterator
```
public class ManualIterator
extends java.lang.Object
implements FocusIterator, SequenceIterator, ReversibleIterator, LastPositionFinder, GroundedIterator, LookaheadIterator
```
ManualIterator: a pseudo-iterator used while streaming. It has a current node and a current position which are set manually. Calling last() is an error. Calling next() always returns null.

Constructor Summary

Constructors
Constructor and Description
`ManualIterator()` Create an uninitialized ManualIterator: this is only usable after the context item, position, and size (if required) have been initialized using setter methods.
`ManualIterator(Item value)` Create a ManualIterator supplying the context item, and setting the value of both "position()" and "last()" implicitly to 1.
`ManualIterator(Item value, int position)` Create a ManualIterator initializing the context item and position.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Item`	`current()` Get the current value in the sequence (the one returned by the most recent call on next()).
`int`	`getLength()` Get the position of the last item in the sequence
`GroundedValue`	`getResidue()` Return a GroundedValue containing all the remaining items in the sequence returned by this SequenceIterator, starting at the current position.
`ManualIterator`	`getReverseIterator()` Get a new SequenceIterator that returns the same items in reverse order.
`boolean`	`hasNext()` Determine whether there are more items to come.
`void`	`incrementPosition()`
`boolean`	`isActuallyGrounded()` Ask if the iterator is actually grounded.
`GroundedValue`	`materialize()` Return a Value containing all the items in the sequence returned by this SequenceIterator
`Item`	`next()` Get the next item in the sequence.
`int`	`position()` Return the current position in the sequence.
`void`	`setContextItem(Item value)`
`void`	`setLengthFinder(java.util.function.Supplier<java.lang.Integer> finder)`
`void`	`setPosition(int position)`
`boolean`	`supportsGetLength()` Ask whether this iterator supports use of the `getLength()` method.
`boolean`	`supportsHasNext()` Ask whether the hasNext() method can be called.

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
close, discharge

- Constructor Detail
  - ManualIterator
```
public ManualIterator()
```
    Create an uninitialized ManualIterator: this is only usable after the context item, position, and size (if required) have been initialized using setter methods.
  - ManualIterator
```
public ManualIterator(Item value,
                      int position)
```
    Create a ManualIterator initializing the context item and position. The value of "last()" for such an iterator is unknown unless a LastPositionFinder is supplied.
    
    Parameters:
    
    value - the context item. May be null if the value is to be initialized later.
    
    position - the context position
  - ManualIterator
```
public ManualIterator(Item value)
```
    Create a ManualIterator supplying the context item, and setting the value of both "position()" and "last()" implicitly to 1.
    
    Parameters:
    
    value - the context item
- Method Detail
  - setContextItem
```
public void setContextItem(Item value)
```
  - setLengthFinder
```
public void setLengthFinder(java.util.function.Supplier<java.lang.Integer> finder)
```
  - incrementPosition
```
public void incrementPosition()
```
  - setPosition
```
public void setPosition(int position)
```
  - supportsHasNext
```
public boolean supportsHasNext()
```
    Description copied from interface: LookaheadIterator
    
    Ask whether the hasNext() method can be called. This method must be called before calling hasNext(), because some iterators implement this interface, but only support look-ahead under particular circumstances (this is usually because they delegate to another iterator)
    
    Specified by:
    
    supportsHasNext in interface LookaheadIterator
    
    Returns:
    
    true if the LookaheadIterator.hasNext() method is available
  - hasNext
```
public boolean hasNext()
```
    Determine whether there are more items to come. Note that this operation is stateless and it is not necessary (or usual) to call it before calling next(). It is used only when there is an explicit need to tell if we are at the last element.
    
    Specified by:
    
    hasNext in interface LookaheadIterator
    
    Returns:
    
    true if there are more items
  - next
```
public Item 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 interface SequenceIterator
    
    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.
  - current
```
public Item current()
```
    Description copied from interface: FocusIterator
    
    Get the current value in the sequence (the one returned by the most recent call on next()). This will be null before the first call of next(). This method does not change the state of the iterator.
    
    Specified by:
    
    current in interface FocusIterator
    
    Returns:
    
    the current item, the one most recently returned by a call on next(). Returns null if next() has not been called, or if the end of the sequence has been reached.
  - position
```
public int position()
```
    Return the current position in the sequence.
    
    Specified by:
    
    position in interface FocusIterator
    
    Returns:
    
    0 before the first call on next(); 1 before the second call on next(); -1 after the second call on next().
  - supportsGetLength
```
public boolean supportsGetLength()
```
    Ask whether this iterator supports use of the getLength() method. This method should always be called before calling getLength(), because an iterator that implements this interface may support use of getLength() in some situations and not in others
    
    Specified by:
    
    supportsGetLength in interface LastPositionFinder
    
    Returns:
    
    true if the getLength() method can be called to determine the length of the underlying sequence.
  - getLength
```
public int getLength()
```
    Description copied from interface: FocusIterator
    
    Get the position of the last item in the sequence
    
    Specified by:
    
    getLength in interface LastPositionFinder
    
    Specified by:
    
    getLength in interface FocusIterator
    
    Returns:
    
    the position of the last item
  - isActuallyGrounded
```
public boolean isActuallyGrounded()
```
    Description copied from interface: GroundedIterator
    
    Ask if the iterator is actually grounded. This method must be called before calling GroundedIterator.materialize() or GroundedIterator.getResidue(), because the iterator might be grounded under some conditions and not others (usually when it delegates to another iterator)
    
    Specified by:
    
    isActuallyGrounded in interface GroundedIterator
    
    Returns:
    
    true if this iterator is grounded
  - getReverseIterator
```
public ManualIterator getReverseIterator()
```
    Description copied from interface: ReversibleIterator
    
    Get a new SequenceIterator that returns the same items in reverse order. If this SequenceIterator is an AxisIterator, then the returned SequenceIterator must also be an AxisIterator.
    
    Specified by:
    
    getReverseIterator in interface ReversibleIterator
    
    Returns:
    
    an iterator over the items in reverse order
  - materialize
```
public GroundedValue materialize()
```
    Return a Value containing all the items in the sequence returned by this SequenceIterator
    
    Specified by:
    
    materialize in interface GroundedIterator
    
    Returns:
    
    the corresponding Value. If the value is a closure or a function call package, it will be evaluated and expanded.
  - getResidue
```
public GroundedValue getResidue()
```
    Description copied from interface: GroundedIterator
    
    Return a GroundedValue containing all the remaining items in the sequence returned by this SequenceIterator, starting at the current position. This should be an "in-memory" value, not a Closure. This method does not change the state of the iterator (in particular, it does not consume the iterator).
    
    Specified by:
    
    getResidue in interface GroundedIterator
    
    Returns:
    
    the corresponding Value

Class ManualIterator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Constructor Detail

ManualIterator

ManualIterator

ManualIterator

Method Detail

setContextItem

setLengthFinder

incrementPosition

setPosition

supportsHasNext

hasNext

next

current

position

supportsGetLength

getLength

isActuallyGrounded

getReverseIterator

materialize

getResidue