Skip to content

Commit 5874257

Browse files
committed
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
1 parent 40fd8bd commit 5874257

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

spring-batch-docs/asciidoc/appendix.adoc

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,13 @@
2020
an `ItemReader`.
2121
|AggregateItemReader|An `ItemReader` that delivers a list as its
2222
item, storing up objects from the injected `ItemReader` until they
23-
are ready to be packed out as a collection. This `ItemReader` should
24-
mark the beginning and end of records with the constant values in
25-
`FieldSetMapper AggregateItemReader#__$$BEGIN_RECORD$$__` and
26-
`AggregateItemReader#__$$END_RECORD$$__`.
23+
are ready to be packed out as a collection. This class must be used
24+
as a wrapper for a custom `ItemReader` that can identify the record
25+
boundaries. The custom reader should mark the beginning and end of
26+
records by returning an `AggregateItem` which responds `true` to its
27+
query methods `isHeader()` and `isFooter()`. Note that this reader
28+
is not part of the library of readers provided by Spring Batch
29+
but given as a sample in `spring-batch-samples`.
2730
|AmqpItemReader|Given a Spring `AmqpTemplate`, it provides
2831
synchronous receive methods. The `receiveAndConvert()` method
2932
lets you receive POJO objects.

0 commit comments

Comments
 (0)