[#BATCH-585] Improve coverage of examples of listener implementations in user guide

Spring Batch

Improve coverage of examples of listener implementations in user guide

Created: 13/Apr/08 08:20 AM Updated: 15/Apr/08 04:10 PM

Component/s:

Documentation

Affects Version/s:

1.0.0

Fix Version/s:

None

Time Tracking:

Original Estimate:

0.25d

Remaining Estimate:

0.25d

Time Spent:

Not Specified

Description

« Hide

Listeners in Spring Batch offer nice injection point for developers to implement their custom application logic and inject to the framework. But there is a bit lack of documentation of the contract of various Listeners interface in the org.springframework.batch.core.listener package. Could you help to improve this in coming releases?

All

Comments

Work Log

Change History

FishEye

Related Builds

Sort Order:

[ Permlink | « Hide ]

Dave Syer added a comment - 13/Apr/08 08:26 AM

Thanks. Can you just clarify something? The listener interfaces are actually all in the org.springframework.batch.core package. Is that where you think more documentation is needed (we did some improvements there already for 1.0)? Or did you mean the concrete listeners (which actually do very little and really don't need much documentation, although I would be happy to add some if it helps)?

[ Permlink | « Hide ]

wordy added a comment - 13/Apr/08 09:20 AM

Thanks for the reminder. Sorry that I missed to look the the javadoc inside the callback methods. Usually, I expect to see some general description and general usage description in for the whole interface in general. Anyway, I think it is okay to leave doc in brief for listeners cases although more description on how to implement or common usage of listener will be better.

[ Permlink | « Hide ]

Dave Syer added a comment - 13/Apr/08 11:26 AM

There are several examples of how to use a listener in the user guide (a better place for usage examples than Javadocs). We can always add more. Did you read them already? Shall I change the summary of this issue to "Improve coverage of examples of listener implementations in user guide"?

[ Permlink | « Hide ]

wordy added a comment - 14/Apr/08 07:41 AM

Many thanks for the prompt reply. I am fine with the proposal on summary change.