Skip to content

Commit

Permalink
Fix misleading documentation regarding the ItemWriteListener
Browse files Browse the repository at this point in the history
Backported from e785391

Issue #4400
  • Loading branch information
fmbenhassine committed Mar 11, 2024
1 parent 8ca9c6e commit f56a21c
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions spring-batch-docs/src/main/asciidoc/step.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -1184,9 +1184,10 @@ public interface ItemWriteListener<S> extends StepListener {
----

The `beforeWrite` method is called before `write` on the `ItemWriter` and is handed the
list of items that is written. The `afterWrite` method is called after the item has been
successfully written. If there was an error while writing, the `onWriteError` method is
called. The exception encountered and the item that was attempted to be written are
list of items that is written. The `afterWrite` method is called after the items have been
successfully written, but before committing the transaction associated with the chunk's processing.
If there was an error while writing, the `onWriteError` method is called.
The exception encountered and the item that was attempted to be written are
provided, so that they can be logged.

The annotations corresponding to this interface are:
Expand Down

0 comments on commit f56a21c

Please sign in to comment.