Top Description Constructors Methods
jakarta.batch.api.chunk

public abstract Class AbstractItemReader

extends Object
implements ItemReader
Class Inheritance
All Implemented Interfaces
jakarta.batch.api.chunk.ItemReader
Imports
java.io.Serializable
The AbstractItemReader provides default implementations of less commonly implemented methods.

Constructor Summary

AccessConstructor and Description
public
AbstractItemReader()

Method Summary

Modifier and TypeMethod and Description
public Serializable

Returns:

checkpoint data
checkpointInfo()

Implements jakarta.batch.api.chunk.ItemReader.checkpointInfo.

Override this method if the ItemReader supports checkpoints.

public void
close()

Implements jakarta.batch.api.chunk.ItemReader.close.

Override this method if the ItemReader requires any close time processing.

public void
open(Serializable
last checkpoint for this ItemReader - may be null.
checkpoint)

Implements jakarta.batch.api.chunk.ItemReader.open.

Override this method if the ItemReader requires any open time processing.

public abstract Object

Returns:

next item or null
readItem()

Redeclares jakarta.batch.api.chunk.ItemReader.readItem.

Implement read logic for the ItemReader in this method.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

AbstractItemReaderback to summary
public AbstractItemReader()

Method Detail

checkpointInfoback to summary
public Serializable checkpointInfo() throws Exception

Implements jakarta.batch.api.chunk.ItemReader.checkpointInfo.

Override this method if the ItemReader supports checkpoints. The default implementation returns null.

Returns:Serializable

checkpoint data

Annotations
@Override
Exceptions
Exception:
(or subclass) if an error occurs.
closeback to summary
public void close() throws Exception

Implements jakarta.batch.api.chunk.ItemReader.close.

Override this method if the ItemReader requires any close time processing. The default implementation does nothing.

Annotations
@Override
Exceptions
Exception:
(or subclass) if an error occurs.
openback to summary
public void open(Serializable checkpoint) throws Exception

Implements jakarta.batch.api.chunk.ItemReader.open.

Override this method if the ItemReader requires any open time processing. The default implementation does nothing.

Parameters
checkpoint:Serializable

last checkpoint for this ItemReader - may be null.

Annotations
@Override
Exceptions
Exception:
(or subclass) if an error occurs.
readItemback to summary
public abstract Object readItem() throws Exception

Redeclares jakarta.batch.api.chunk.ItemReader.readItem.

Implement read logic for the ItemReader in this method.

Returns:Object

next item or null

Annotations
@Override
Exceptions
Exception:
(or subclass) if an error occurs.