Skip to content

Misleading documentation on ItemWriteListener #4400

Closed
@littlewoo

Description

@littlewoo

The reference doc for ItemWriteListener says:

The afterWrite method is called after the item has been successfully written

However, digging into the Javadoc for ItemWriteListener, it seems otherwise:

This is called before any transaction is committed

"after successfully written" suggests that the transaction will have already been committed. The reference documentation should be updated to specify that "after successfully written" actually means before the transaction is committed (i.e. during the write, not after it).

Activity

hwan33

hwan33 commented on Nov 3, 2023

@hwan33
Contributor

Can i work on this issue?

fmbenhassine

fmbenhassine commented on Nov 6, 2023

@fmbenhassine
Contributor

@hwan33 Sure!

As a rule of thumb, no need to ask for contributions. Any issue not tagged with status: for-internal-team is open for contributions. Look for issues tagged with status: ideal-for-contribution as well. Thank you for your offer to help!

added a commit that references this issue on Nov 18, 2023
022ccd1
added this to the 5.2.0 milestone on Mar 11, 2024
changed the title [-]Documentation on ItemWriteListener is misleading.[/-] [+]Misleading documentation on ItemWriteListener[/+] on Mar 11, 2024
added a commit that references this issue on Mar 11, 2024
dbb4e21

6 remaining items

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @fmbenhassine@littlewoo@hwan33

        Issue actions

          Misleading documentation on ItemWriteListener · Issue #4400 · spring-projects/spring-batch