com.ibm.openpages.api

## Interface BatchIterator<E>

- All Superinterfaces:
    IDisposable, java.util.Iterator<E>

      public interface BatchIterator<E>
      extends java.util.Iterator<E>, IDisposable

  This `Iterator` interface loads objects for iteration in batches to reduce memory footprint. This `Iterator` is ideal for handling large data sets. This interface also extends the `IDisposable` interface, which provides cleanup handle.

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static int` | `DEFAULT_BATCH_SIZE` Default batch size

  - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `setBatchSize(int size)` Set batch size

    - ### Methods inherited from interface java.util.Iterator

      `forEachRemaining, hasNext, next, remove`

    - ### Methods inherited from interface com.ibm.openpages.api.IDisposable

      `close`

- - ### Field Detail

    - #### DEFAULT_BATCH_SIZE

          static final int DEFAULT_BATCH_SIZE

      Default batch size
      See Also:
        Constant Field Values

  - ### Method Detail

    - #### setBatchSize

          void setBatchSize(int size)

      Set batch size
      Parameters:
        `size` - the batch size

Licensed Materials - Property of IBM
OpenPages with Watson (PID: 5725-D51)
© Copyright IBM Corporation 2013, 2022. All Rights Reserved.
US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.