クラス StepExecutionSimpleCompletionPolicy

java.lang.ObjectSE
org.springframework.batch.core.resource.StepExecutionSimpleCompletionPolicy
実装済みのインターフェース一覧:
StepExecutionListener, StepListener, CompletionPolicy
@NullUnmarked @DeprecatedSE(since="6.0", forRemoval=true) public class StepExecutionSimpleCompletionPolicy extends ObjectSE implements StepExecutionListener, CompletionPolicy
非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
6.0 以降、代替はありません。6.2 以降で削除される予定です。

ステップの開始をリッスンすることにより、JobParameters からコミット間隔を取得する CompletionPolicy。CompletionPolicy を使用できる場所であればどこでも（通常はステップのチャンクレベルで）使用し、StepExecutionListener として周囲のステップに注入します。N.B. ステップが開始された後にのみ、完了ポリシーが使用可能になります。

遅延バインディング式（#{jobParameters['commit.interval']} など）である commit-interval を使用してチャンクを宣言する方が簡単で、おそらく望ましいでしょう。その機能は Spring Batch 2.1.7 から利用できます。

作成者:
Dave Syer, Mahmoud Ben Hassine
関連事項:

  • コンストラクター概要

    コンストラクター
    コンストラクター
    説明
    StepExecutionSimpleCompletionPolicy()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  • 方法の概要

    修飾子と型
    メソッド
    説明
    void
    beforeStep(StepExecution stepExecution)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    JobParameters から取得したコミット間隔で SimpleCompletionPolicy をセットアップします。
    boolean
    isComplete(RepeatContext context)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    コールバックが完了するのを待たずに、ポリシーが内部状態に従って完了を通知できるようにします。
    boolean
    isComplete(RepeatContext context, RepeatStatus result)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    コールバックからの最新の結果を考慮して、バッチが完了したかどうかを判断します。
    void
    setKeyName(StringSE keyName)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    コミット間隔を含む JobParameters の Long 値のキー名のパブリック setter。
    RepeatContext
    start(RepeatContext parent)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    バッチを実行するための新しいコンテキストを作成します。
    StringSE
    toString()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    設定されている場合はラップされた CompletionPolicy にデリゲートし、そうでない場合は setKeyName(String) の値を返します。
    void
    update(RepeatContext context)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    実装に現在のバッチの状態を更新する機会を与えます。

    クラス ObjectSE から継承されたメソッド

    clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, wait, waitSE, waitSE

    インターフェース StepExecutionListener から継承されたメソッド

    afterStep

  • コンストラクターの詳細

    • StepExecutionSimpleCompletionPolicy

      public StepExecutionSimpleCompletionPolicy()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  • メソッドの詳細

    • setKeyName

      public void setKeyName(StringSE keyName)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      コミット間隔を含む JobParameters の Long 値のキー名のパブリック setter。デフォルトは "commit.interval" です。
      パラメーター:
      keyName - 設定する keyName

    • beforeStep

      public void beforeStep(StepExecution stepExecution)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      JobParameters から取得したコミット間隔で SimpleCompletionPolicy を設定します。指定されたキー名を持つ Long パラメーターがある場合は、このパラメーターの intValue が使用されます。ない場合は例外がスローされます。
      次で指定:
      インターフェース StepExecutionListener の beforeStep 
      パラメーター:
      stepExecution - StepExecution のインスタンス。
      関連事項:

    • isComplete

      public boolean isComplete(RepeatContext context, RepeatStatus result)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      インターフェースからコピーされた説明: CompletionPolicy
      コールバックからの最新の結果を考慮して、バッチが完了したかどうかを判断します。このメソッドが true を返す場合、CompletionPolicy.isComplete(RepeatContext) も同じである必要があります（ただし、必ずしもその逆ではないため、ここでの答えは結果に依存するため）。
      次で指定:
      インターフェース CompletionPolicy の isComplete 
      パラメーター:
      context - 現在のバッチコンテキスト。
      result - 最新のバッチアイテム処理の結果。
      戻り値:
      コミット間隔に達した場合、または結果が完了を示している場合は true
      関連事項:

    • isComplete

      public boolean isComplete(RepeatContext context)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      インターフェースからコピーされた説明: CompletionPolicy
      コールバックが完了するのを待たずに、ポリシーが内部状態に従って完了を通知できるようにします。
      次で指定:
      インターフェース CompletionPolicy の isComplete 
      パラメーター:
      context - 現在のバッチコンテキスト。
      戻り値:
      コミット間隔に達した場合
      関連事項:

    • start

      public RepeatContext start(RepeatContext parent)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      インターフェースからコピーされた説明: CompletionPolicy
      バッチを実行するための新しいコンテキストを作成します。NB 実装は、このメソッドから親を返すべきではありません。ポリシーの特定のニーズを満たすために、新しいコンテキストを作成する必要があります。これを行う最善の方法は、既存の実装をオーバーライドし、RepeatContext を使用して属性に状態を格納することです。
      次で指定:
      インターフェース CompletionPolicy の start 
      パラメーター:
      parent - 進行中の場合は現在のコンテキスト。
      戻り値:
      新しい RepeatContext
      関連事項:

    • update

      public void update(RepeatContext context)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      インターフェースからコピーされた説明: CompletionPolicy
      実装に現在のバッチの状態を更新する機会を与えます。コールバックが起動された後、コールバックごとに 1 回呼び出されますが、必ずしも完了した後ではありません（バッチが非同期の場合）。
      次で指定:
      インターフェース CompletionPolicy の update 
      パラメーター:
      context - start によって返される値。
      関連事項:

    • toString

      public StringSE toString()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      設定されている場合はラップされた CompletionPolicy にデリゲートし、そうでない場合は setKeyName(String) の値を返します。
      オーバーライド:
      クラス ObjectSE の toString 

Copyright © 2026 Spring. All rights reserved.