Package org.apache.beam.sdk.util.common

Class ElementByteSizeObservableIterable<V,​InputT extends ElementByteSizeObservableIterator<V>>

  • Type Parameters:
    V - the type of elements returned by this iterable
    InputT - type type of iterator returned by this iterable
    All Implemented Interfaces:
    java.lang.Iterable<V>
    @Internal
public abstract class ElementByteSizeObservableIterable<V,​InputT extends ElementByteSizeObservableIterator<V>>
extends java.lang.Object
implements java.lang.Iterable<V>
    An abstract class used for iterables that notify observers about size in bytes of their elements, as they are being iterated over.

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void addObserver​(java.util.Observer observer)
      Sets the observer, which will observe the iterator returned in the next call to iterator() method.
      protected abstract InputT createIterator()
      Derived classes override this method to return an iterator for this iterable.
      InputT iterator()
      Returns a new iterator for this iterable.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator

    • Constructor Detail

      • ElementByteSizeObservableIterable

        public ElementByteSizeObservableIterable()

    • Method Detail

      • createIterator

        protected abstract InputT createIterator()
        Derived classes override this method to return an iterator for this iterable.

      • addObserver

        public void addObserver​(java.util.Observer observer)
        Sets the observer, which will observe the iterator returned in the next call to iterator() method. Future calls to iterator() won't be observed, unless an observer is set again.

      • iterator

        public InputT iterator()
        Returns a new iterator for this iterable. If an observer was set in a previous call to setObserver(), it will observe the iterator returned.
        Specified by:
        iterator in interface java.lang.Iterable<V>