Top Description Methods
jakarta.batch.api.chunk.listener

public Interface ItemWriteListener

Known Direct Implementers
jakarta.batch.api.chunk.listener.AbstractItemWriteListener
Imports
java.util.List
ItemWriteListener intercepts item writer processing.

Method Summary

Modifier and TypeMethod and Description
public void
afterWrite(List<Object>
specifies the items written by the item writer.
items)

The afterWrite method receives control after an item writer writes its items.

public void
beforeWrite(List<Object>
specifies the items about to be written.
items)

The beforeWrite method receives control before an item writer is called to write its items.

public void
onWriteError(List<Object>
specifies the items which the item writer attempted to write.
items, Exception
specifies the exception thrown by the item writer.
ex)

The onWriteError method receives control after an item writer writeItems throws an exception.

Method Detail

afterWriteback to summary
public void afterWrite(List<Object> items) throws Exception

The afterWrite method receives control after an item writer writes its items. The method receives the list of items sent to the item writer as an input.

Parameters
items:List<Object>

specifies the items written by the item writer.

Exceptions
Exception:
is thrown if an error occurs.
beforeWriteback to summary
public void beforeWrite(List<Object> items) throws Exception

The beforeWrite method receives control before an item writer is called to write its items. The method receives the list of items sent to the item writer as an input.

Parameters
items:List<Object>

specifies the items about to be written.

Exceptions
Exception:
is thrown if an error occurs.
onWriteErrorback to summary
public void onWriteError(List<Object> items, Exception ex) throws Exception

The onWriteError method receives control after an item writer writeItems throws an exception. The method receives the list of items sent to the item writer as input.

Parameters
items:List<Object>

specifies the items which the item writer attempted to write.

ex:Exception

specifies the exception thrown by the item writer.

Exceptions
Exception:
is thrown if an error occurs.