Updated documentation to outline skip behaviour of RepositoryItemReader

This commit addresses via documentation the issues with using a paging
algorithm for the RepositoryItemReader.

Resolves BATCH-2589
This commit is contained in:
Michael Minella
2017-11-27 10:55:57 -06:00
parent 8a223e35c6
commit 8fa5929a44

View File

@@ -59,6 +59,12 @@ import org.springframework.util.MethodInvoker;
* <code>saveState=false</code> if used in a multi-threaded client (no restart available).
* </p>
*
* <p>It is important to note that this is a paging item reader and exceptions that are
* thrown while reading the page itself (mapping results to objects, etc in the
* {@link RepositoryItemReader#doPageRead()}) will not be skippable since this reader has
* no way of knowing if an exception should be skipped and therefore will continue to read
* the same page until the skip limit is exceeded.</p>
*
* <p>
* NOTE: The {@code RepositoryItemReader} only reads Java Objects i.e. non primitives.
* </p>