javax.batch.api.chunk
Class AbstractItemReader<T>

java.lang.Object
  javax.batch.api.chunk.AbstractItemReader<T>

Type Parameters:

T - specifies the item type read by the ItemReader.

All Implemented Interfaces:

ItemReader<T>

public abstract class AbstractItemReader<T>
extends Object
implements ItemReader<T>

The AbstractItemReader provides default implementations of less commonly implemented methods.

Constructor Summary

AbstractItemReader()

Method Summary

Serializable	checkpointInfo() Override this method if the ItemReader supports checkpoints.
void	close() Override this method if the ItemReader requires any close time processing.
void	open(Serializable checkpoint) * Override this method if the ItemReader requires any open time processing.
abstract T	readItem() Implement read logic for the ItemReader in this method.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractItemReader

public AbstractItemReader()

Method Detail

open

public void open(Serializable checkpoint)
          throws Exception

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

Specified by:

open in interface ItemReader<T>

Parameters:

last - checkpoint for this ItemReader - may be null.

Throws:

Exception - (or subclass) if an error occurs.

close

public void close()
           throws Exception

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

Specified by:

close in interface ItemReader<T>

Throws:

Exception - (or subclass) if an error occurs.

readItem

public abstract T readItem()
                    throws Exception

Implement read logic for the ItemReader in this method.

Specified by:

readItem in interface ItemReader<T>

Returns:

next item or null

Throws:

Exception - (or subclass) if an error occurs.

checkpointInfo

public Serializable checkpointInfo()
                            throws Exception

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

Specified by:

checkpointInfo in interface ItemReader<T>

Returns:

checkpoint data

Throws:

Exception - (or subclass) if an error occurs.