Interface MutableObjectIterator<E>

  • Type Parameters:
    E - The element type of the collection iterated over.

    @Internal
    public interface MutableObjectIterator<E>
    A simple iterator interface. The key differences to the Iterator are
    • It has two distinct next(), where one variant allows to pass an object that may be reused, if the type is mutable.
    • It consolidates the logic in a single next() function, rather than splitting it over two different functions such as hasNext() and next()
    • Method Detail

      • next

        E next​(E reuse)
        throws IOException
        Gets the next element from the collection. The contents of that next element is put into the given reuse object, if the type is mutable.
        Parameters:
        reuse - The target object into which to place next element if E is mutable.
        Returns:
        The filled object or null if the iterator is exhausted.
        Throws:
        IOException - Thrown, if a problem occurred in the underlying I/O layer or in the serialization / deserialization logic
      • next

        E next()
        throws IOException
        Gets the next element from the collection. The iterator implementation must obtain a new instance.
        Returns:
        The object or null if the iterator is exhausted.
        Throws:
        IOException - Thrown, if a problem occurred in the underlying I/O layer or in the serialization / deserialization logic