From 6ab141bb44bb86ee7aacd5d604fd37971a7344ee Mon Sep 17 00:00:00 2001 From: Mahmoud Ben Hassine Date: Fri, 13 Mar 2020 11:19:26 +0100 Subject: [PATCH] Fix incorrect description of AggregateItemReader in "Appendix A" This commit fixes incorrect references to `AggregateItemReader#__$$BEGIN_RECORD$$__` and `AggregateItemReader#__$$END_RECORD$$__` by updating the description of the reader with the one in its Javadoc. It also adds a note that the AggregateItemReader is not part of the standard library of readers provided by Spring Batch but only given as a sample. Issue #1793 --- spring-batch-docs/asciidoc/appendix.adoc | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/spring-batch-docs/asciidoc/appendix.adoc b/spring-batch-docs/asciidoc/appendix.adoc index efd883b00..502e3d059 100644 --- a/spring-batch-docs/asciidoc/appendix.adoc +++ b/spring-batch-docs/asciidoc/appendix.adoc @@ -20,10 +20,13 @@ an `ItemReader`. |AggregateItemReader|An `ItemReader` that delivers a list as its item, storing up objects from the injected `ItemReader` until they - are ready to be packed out as a collection. This `ItemReader` should - mark the beginning and end of records with the constant values in - `FieldSetMapper AggregateItemReader#__$$BEGIN_RECORD$$__` and - `AggregateItemReader#__$$END_RECORD$$__`. + are ready to be packed out as a collection. This class must be used + as a wrapper for a custom `ItemReader` that can identify the record + boundaries. The custom reader should mark the beginning and end of + records by returning an `AggregateItem` which responds `true` to its + query methods `isHeader()` and `isFooter()`. Note that this reader + is not part of the library of readers provided by Spring Batch + but given as a sample in `spring-batch-samples`. |AmqpItemReader|Given a Spring `AmqpTemplate`, it provides synchronous receive methods. The `receiveAndConvert()` method lets you receive POJO objects.