Package org.springframework.batch.item

Class Chunk<W>

java.lang.Object
org.springframework.batch.item.Chunk<W>
All Implemented Interfaces:
Serializable, Iterable<W>
public class Chunk<W> extends Object implements Iterable<W>, Serializable
Encapsulation of a list of items to be processed and possibly a list of failed items to be skipped. To mark an item as skipped, clients should iterate over the chunk using the iterator() method, and if there is a failure call Chunk.ChunkIterator.remove() on the iterator. The skipped items are then available through the chunk.
Since:
2.0
Author:
Dave Syer, Mahmoud Ben Hassine, Jinwoo Bae
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    class 
    Chunk.ChunkIterator
    Special iterator for a chunk providing the Chunk.ChunkIterator.remove(Throwable) method for dynamically removing an item and adding it to the skips.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Chunk(List<? extends W> items)
     
    Chunk(List<? extends W> items, List<SkipWrapper<W>> skips)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Chunk(W... items)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    add(W item)
    Add the item to the chunk.
    void
    addAll(List<W> items)
    Add all items to the chunk.
    void
    clear()
    Clear the items down to signal that we are done.
    void
    clearSkips()
    Deprecated, for removal: This API element is subject to removal in a future version.
    boolean
    equals(Object obj)
     
    List<Exception>
    getErrors()
    Deprecated, for removal: This API element is subject to removal in a future version.
    List<W>
    getItems()
     
    List<SkipWrapper<W>>
    getSkips()
    Deprecated, for removal: This API element is subject to removal in a future version.
    int
    getSkipsSize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Object
    getUserData()
    Deprecated, for removal: This API element is subject to removal in a future version.
    int
    hashCode()
     
    boolean
    isBusy()
    Deprecated, for removal: This API element is subject to removal in a future version.
    boolean
    isEmpty()
     
    boolean
    isEnd()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Chunk<W>.ChunkIterator
    iterator()
    Get an unmodifiable iterator for the underlying items.
    static <W> Chunk<W>
    of(W... items)
     
    void
    setBusy(boolean busy)
    Deprecated, for removal: This API element is subject to removal in a future version.
    void
    setEnd()
    Deprecated, for removal: This API element is subject to removal in a future version.
    void
    setUserData(Object userData)
    Deprecated, for removal: This API element is subject to removal in a future version.
    int
    size()
     
    void
    skip(Exception e)
    Deprecated, for removal: This API element is subject to removal in a future version.
    String
    toString()
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface java.lang.Iterable

    forEach, spliterator

  • Constructor Details

  • Method Details

    • of

      @SafeVarargs public static <W> Chunk<W> of(W... items)

    • add

      public void add(W item)
      Add the item to the chunk.
      Parameters:
      item - the item to add

    • addAll

      public void addAll(List<W> items)
      Add all items to the chunk.
      Parameters:
      items - the items to add

    • clear

      public void clear()
      Clear the items down to signal that we are done.

    • getItems

      public List<W> getItems()
      Returns:
      a copy of the items to be processed as an unmodifiable list

    • getSkips

      @Deprecated(since="6.0", forRemoval=true) public List<SkipWrapper<W>> getSkips()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns:
      a copy of the skips as an unmodifiable list

    • getErrors

      @Deprecated(since="6.0", forRemoval=true) public List<Exception> getErrors()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns:
      a copy of the anonymous errors as an unmodifiable list

    • skip

      @Deprecated(since="6.0", forRemoval=true) public void skip(Exception e)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Register an anonymous skip. To skip an individual item, use Chunk.ChunkIterator.remove().
      Parameters:
      e - the exception that caused the skip

    • isEmpty

      public boolean isEmpty()
      Returns:
      true if there are no items in the chunk

    • iterator

      public Chunk<W>.ChunkIterator iterator()
      Get an unmodifiable iterator for the underlying items.
      Specified by:
      iterator in interface Iterable<W>
      See Also:

    • size

      public int size()
      Returns:
      the number of items (excluding skips)

    • getSkipsSize

      @Deprecated(since="6.0", forRemoval=true) public int getSkipsSize()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns:
      the number of skipped items

    • isEnd

      @Deprecated(since="6.0", forRemoval=true) public boolean isEnd()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Flag to indicate if the source data is exhausted.

      Note: This may return false if the last chunk has the same number of items as the configured commit interval. Consequently, in such cases,there will be a last empty chunk that won't be processed. It is recommended to consider this behavior when utilizing this method.

      Returns:
      true if there is no more data to process

    • setEnd

      @Deprecated(since="6.0", forRemoval=true) public void setEnd()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set the flag to say that this chunk represents an end of stream (there is no more data to process).

    • isBusy

      @Deprecated(since="6.0", forRemoval=true) public boolean isBusy()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Query the chunk to see if anyone has registered an interest in keeping a reference to it.
      Returns:
      the busy flag

    • setBusy

      @Deprecated(since="6.0", forRemoval=true) public void setBusy(boolean busy)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Register an interest in the chunk to prevent it from being cleaned up before the flag is reset to false.
      Parameters:
      busy - the flag to set

    • clearSkips

      @Deprecated(since="6.0", forRemoval=true) public void clearSkips()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Clear only the skips list.

    • getUserData

      @Deprecated(since="6.0", forRemoval=true) public Object getUserData()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setUserData

      @Deprecated(since="6.0", forRemoval=true) public void setUserData(Object userData)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object