パッケージ jakarta.batch.api.chunk

インターフェース ItemWriter

  • すべての既知の実装クラス:
    AbstractItemWriter

    public interface ItemWriter
    ItemWriter は、チャンク処理のためにアイテムのリストに書き込むバッチアーティファクトを定義します。
    • メソッドのサマリー

      すべてのメソッド   インスタンスメソッド   抽象メソッド  
      修飾子と型 メソッド 説明
      SerializableSEcheckpointInfo()
      checkpointInfo メソッドは、このライターの現在のチェックポイントデータを返します。
      voidclose()
      close メソッドは、ItemWriter の使用の終了を示します。
      voidopen​(SerializableSE checkpoint)
      open メソッドは、ライターがアイテムを書き込む準備をします。
      voidwriteItems​(ListSE<ObjectSE> items)
      writeItems メソッドは、現在のチャンクのアイテムのリストを書き込みます。
    • メソッドの詳細

      • open

        void open​(SerializableSE checkpoint)
           throws ExceptionSE
        open メソッドは、ライターがアイテムを書き込む準備をします。入力パラメーターは、特定のジョブインスタンスにおけるこのライターの最後のチェックポイントを表します。チェックポイントデータは、このライターによって定義され、checkpointInfo メソッドによって提供されます。チェックポイントデータは、ライターが再起動時にアイテムの書き込みを再開するために必要なすべての情報をライターに提供します。最初の起動時には、チェックポイント値 null が渡されます。
        パラメーター:
        checkpoint - 最後のチェックポイントを指定します
        例外:
        ExceptionSE - エラーが発生するとスローされます。
      • close

        void close()
            throws ExceptionSE
        close メソッドは、ItemWriter の使用の終了を示します。ライターは必要なクリーンアップを自由に行うことができます。
        例外:
        ExceptionSE - エラーが発生するとスローされます。
      • writeItems

        void writeItems​(ListSE<ObjectSE> items)
                 throws ExceptionSE
        writeItems メソッドは、現在のチャンクのアイテムのリストを書き込みます。
        パラメーター:
        items - 書き込む項目のリストを指定します。これは空のリストである可能性があります(たとえば、すべてのアイテムが ItemProcessor によってフィルターで除外されている場合)。
        例外:
        ExceptionSE - エラーが発生するとスローされます。
      • checkpointInfo

        SerializableSE checkpointInfo()
                             throws ExceptionSE
        checkpointInfo メソッドは、このライターの現在のチェックポイントデータを返します。チャンクチェックポイントがコミットされる前に呼び出されます。
        戻り値:
        チェックポイントデータ
        例外:
        ExceptionSE - エラーが発生するとスローされます。