パッケージ org.springframework.batch.core

クラス ExitStatus

java.lang.ObjectSE
org.springframework.batch.core.ExitStatus
実装されたすべてのインターフェース:
SerializableSE, ComparableSE<ExitStatus>
public class ExitStatus extends ObjectSE implements SerializableSE, ComparableSE<ExitStatus>
ジョブまたはステップ実行のステータスに関する情報を保持するために使用される値オブジェクト。

ExitStatus は不変であるため、スレッドセーフです。

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

  • フィールドの詳細

    • UNKNOWN

      public static final ExitStatus UNKNOWN
      不明な状態を表す便利な定数値 - 継続できないと想定されます。

    • EXECUTING

      public static final ExitStatus EXECUTING
      処理がまだ行われている継続可能な状態を表す便利な定数値なので、これ以上のアクションは必要ありません。別のスレッドまたはプロセスで処理が行われ、呼び出し元が結果を待つ必要がない非同期実行シナリオで使用されます。

    • COMPLETED

      public static final ExitStatus COMPLETED
      終了した処理を表す便利な定数値。

    • NOOP

      public static final ExitStatus NOOP
      処理を行わなかったジョブを表す便利な定数値 (たとえば、すでに完了しているため)。

    • FAILED

      public static final ExitStatus FAILED
      エラーで終了した処理を表す便利な定数値。

    • STOPPED

      public static final ExitStatus STOPPED
      ステータスが中断された終了処理を表す便利な定数値。

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

    • ExitStatus

      public ExitStatus(StringSE exitCode)
      終了コードを受け取り、終了の説明を空の StringSE に設定するコンストラクター。
      パラメーター:
      exitCode - ExitStatus に使用される終了コード。

    • ExitStatus

      public ExitStatus(StringSE exitCode, StringSE exitDescription)
      ExitStatus の終了コードと終了の説明を確立するコンストラクター。
      パラメーター:
      exitCode - ExitStatus に使用される終了コード。
      exitDescription - ExitStatus に使用される出口の説明。

  • メソッドの詳細

    • getExitCode

      public StringSE getExitCode()
      終了コードの Getter（デフォルトは空白）。
      戻り値:
      終了コード。

    • getExitDescription

      public StringSE getExitDescription()
      出口の説明には Getter (デフォルトは空白です)
      戻り値:
      出口記述を含む StringSE。

    • and

      public ExitStatus and(ExitStatus status)
      終了コードと説明の連結を論理的に組み合わせて、新しい ExitStatus を作成します。いずれかの値の重大度が高い場合、その終了コードが結果で使用されます。重大度が同じ場合、新しい値がアルファベット順で大きい場合、終了コードが置き換えられます。

      重大度は、終了コードによって定義されます。
      • EXECUTING で始まるコードの重大度は 1 です。
      • COMPLETED で始まるコードの重大度は 2 です
      • NOOP で始まるコードの重大度は 3 です。
      • STOPPED で始まるコードの重大度は 4 です
      • FAILED で始まるコードの重大度は 5 です
      • UNKNOWN で始まるコードの重大度は 6 です
      その他の重大度は 7 であるため、カスタム終了コードが常に優先されます。
      入力が null の場合は、これを返します。
      パラメーター:
      status - これと組み合わせる ExitStatus オブジェクト。
      戻り値:
      現在の値と提供された引数を組み合わせた新しい ExitStatus

    • compareTo

      public int compareTo(ExitStatus status)
      次で指定:
      インターフェース ComparableSE<ExitStatus> の compareToSE 
      パラメーター:
      status - 比較する ExitStatus
      戻り値:
      重大度と終了コードに応じて、ゼロより大きい、0、またはゼロより小さい。
      関連事項:

    • toString

      public StringSE toString()
      オーバーライド:
      クラス ObjectSE の toString 

    • equals

      public boolean equals(ObjectSE obj)
      フィールドを 1 つずつ比較します。
      オーバーライド:
      クラス ObjectSE の equalsSE 
      関連事項:

    • hashCode

      public int hashCode()
      イコールの実装と互換性があります。
      オーバーライド:
      クラス ObjectSE の hashCode 
      関連事項:

    • replaceExitCode

      public ExitStatus replaceExitCode(StringSE code)
      既存の ExitStatus に終了コードを追加します。コードがすでに存在する場合は、置き換えられます。
      パラメーター:
      code - 追加するコード。
      戻り値:
      同じプロパティを持つ新しい ExitStatus ですが、新しい終了コードがあります。

    • isRunning

      public boolean isRunning()
      このステータスが実行中のプロセスを表すかどうかを確認します。
      戻り値:
      終了コードが EXECUTING または UNKNOWN の場合は true。

    • addExitDescription

      public ExitStatus addExitDescription(StringSE description)
      exit の説明を既存の ExitStatus に追加します。説明がすでに存在する場合は、2 つがセミコロンで連結されます。
      パラメーター:
      description - 追加する説明。
      戻り値:
      プロパティは同じですが、出口の説明が新しい新しい ExitStatus。

    • addExitDescription

      public ExitStatus addExitDescription(ThrowableSE throwable)
      提供されたスロー可能オブジェクトからスタックトレースを抽出し、既存の説明に追加します。
      パラメーター:
      throwable - スタックトレースを含む ThrowableSE インスタンス。
      戻り値:
      スタックトレースが追加された新しい ExitStatus。

    • isNonDefaultExitStatus

      public static boolean isNonDefaultExitStatus(ExitStatus status)
      パラメーター:
      status - 評価される終了コードを含む ExitStatus オブジェクト。
      戻り値:
      値が既知の終了コードと一致する場合は true。