Package org.apache.kafka.streams.state

Interface KeyValueIterator<K,​V>

  • Type Parameters:
    K - Type of keys
    V - Type of values
    All Superinterfaces:
    java.lang.AutoCloseable, java.io.Closeable, java.util.Iterator<KeyValue<K,​V>>
    All Known Subinterfaces:
    PeekingKeyValueIterator<K,​V>, WindowStoreIterator<V>
    All Known Implementing Classes:
    DelegatingPeekingKeyValueIterator, KeyValueIteratorFacade
    public interface KeyValueIterator<K,​V>
extends java.util.Iterator<KeyValue<K,​V>>, java.io.Closeable
    Iterator interface of KeyValue.

    Users must call its close method explicitly upon completeness to release resources, or use try-with-resources statement (available since JDK7) for this Closeable class. Note that remove() is not supported.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void close()  
      K peekNextKey()
      Peek at the next key without advancing the iterator

      • Methods inherited from interface java.util.Iterator

        forEachRemaining, hasNext, next, remove

    • Method Detail

      • close

        void close()
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable

      • peekNextKey

        K peekNextKey()
        Peek at the next key without advancing the iterator
        Returns:
        the key of the next value that would be returned from the next call to next