From 8fa5929a440ecdf90c7601fa3238509a488a21c3 Mon Sep 17 00:00:00 2001
From: Michael Minella <mminella@pivotal.io>
Date: Mon, 27 Nov 2017 10:55:57 -0600
Subject: [PATCH] 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
---
 .../batch/item/data/RepositoryItemReader.java               | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/RepositoryItemReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/RepositoryItemReader.java
index 4ece01270..b0dff3b92 100644
--- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/RepositoryItemReader.java
+++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/data/RepositoryItemReader.java
@@ -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>