|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.springframework.batch.core.step.item.Chunk<W>
public class Chunk<W>
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(Exception) on the iterator. The
skipped items are then available through the chunk.
| Nested Class Summary | |
|---|---|
class |
Chunk.ChunkIterator
Special iterator for a chunk providing the Chunk.ChunkIterator.remove(Exception)
method for dynamically removing an item and adding it to the skips. |
| Constructor Summary | |
|---|---|
Chunk()
|
|
Chunk(java.util.Collection<? extends W> items)
|
|
Chunk(java.util.Collection<? extends W> items,
java.util.List<SkipWrapper<W>> skips)
|
|
| Method Summary | |
|---|---|
void |
add(W item)
Add the item to the chunk. |
void |
clear()
Clear the items down to signal that we are done. |
void |
clearSkips()
Clear only the skips list. |
java.util.List<java.lang.Exception> |
getErrors()
|
java.util.List<W> |
getItems()
|
java.util.List<SkipWrapper<W>> |
getSkips()
|
java.lang.Object |
getUserData()
|
boolean |
isBusy()
Query the chunk to see if anyone has registered an interest in keeping a reference to it. |
boolean |
isEmpty()
|
boolean |
isEnd()
Flag to indicate if the source data is exhausted. |
Chunk.ChunkIterator |
iterator()
Get an unmodifiable iterator for the underlying items. |
void |
setBusy(boolean busy)
Register an interest in the chunk to prevent it from being cleaned up before the flag is reset to false. |
void |
setEnd()
Set the flag to say that this chunk represents an end of stream (there is no more data to process). |
void |
setUserData(java.lang.Object userData)
|
int |
size()
|
void |
skip(java.lang.Exception e)
Register an anonymous skip. |
java.lang.String |
toString()
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public Chunk()
public Chunk(java.util.Collection<? extends W> items)
public Chunk(java.util.Collection<? extends W> items,
java.util.List<SkipWrapper<W>> skips)
| Method Detail |
|---|
public void add(W item)
item - public void clear()
public java.util.List<W> getItems()
public java.util.List<SkipWrapper<W>> getSkips()
public java.util.List<java.lang.Exception> getErrors()
public void skip(java.lang.Exception e)
Chunk.ChunkIterator.remove().
e - the exception that caused the skippublic boolean isEmpty()
public Chunk.ChunkIterator iterator()
iterator in interface java.lang.Iterable<W>Iterable.iterator()public int size()
public boolean isEnd()
public void setEnd()
public boolean isBusy()
public void setBusy(boolean busy)
busy - the flag to setpublic void clearSkips()
public java.lang.Object getUserData()
public void setUserData(java.lang.Object userData)
public java.lang.String toString()
toString in class java.lang.Object
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||