Package javax.batch.api.chunk

Class AbstractItemReader

  • All Implemented Interfaces:
    ItemReader

    public abstract class AbstractItemReader
extends java.lang.Object
implements ItemReader
    The AbstractItemReader provides default implementations of less commonly implemented methods.

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      java.io.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​(java.io.Serializable checkpoint)
      Override this method if the ItemReader requires any open time processing.
      abstract java.lang.Object 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​(java.io.Serializable checkpoint)
          throws java.lang.Exception
        Override this method if the ItemReader requires any open time processing. The default implementation does nothing.
        Specified by:
        open in interface ItemReader
        Parameters:
        checkpoint - last checkpoint for this ItemReader - may be null.
        Throws:
        java.lang.Exception - (or subclass) if an error occurs.

      • close

        public void close​()
           throws java.lang.Exception
        Override this method if the ItemReader requires any close time processing. The default implementation does nothing.
        Specified by:
        close in interface ItemReader
        Throws:
        java.lang.Exception - (or subclass) if an error occurs.

      • readItem

        public abstract java.lang.Object readItem​()
                                   throws java.lang.Exception
        Implement read logic for the ItemReader in this method.
        Specified by:
        readItem in interface ItemReader
        Returns:
        next item or null
        Throws:
        java.lang.Exception - (or subclass) if an error occurs.

      • checkpointInfo

        public java.io.Serializable checkpointInfo​()
                                    throws java.lang.Exception
        Override this method if the ItemReader supports checkpoints. The default implementation returns null.
        Specified by:
        checkpointInfo in interface ItemReader
        Returns:
        checkpoint data
        Throws:
        java.lang.Exception - (or subclass) if an error occurs.