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

クラス JobParametersBuilder

java.lang.ObjectSE
org.springframework.batch.core.JobParametersBuilder
public class JobParametersBuilder extends ObjectSE
JobParameters を作成するためのヘルパークラス。すべての JobParameter オブジェクトは不変であり、型の安全性を確保するために個別にインスタンス化する必要があるため便利です。作成後は、さまざまなパラメーター型を追加し、終了後に有効な JobParameters オブジェクトを作成することで、StringBuilderSE と同じように使用できます (ただし、順序は関係ありません)。

 identifying フラグを使用すると、パラメーターを JobInstance オブジェクトの識別に使用する必要があるかどうかが示されます。そのフラグのデフォルトは true です。
導入:
1.0
作成者:
Lucas Ward, Michael Minella, Glenn Renfro, Mahmoud Ben Hassine
関連事項:

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

    • JobParametersBuilder

      public JobParametersBuilder()
      デフォルトのコンストラクター。空のパラメーターでビルダーを初期化します。

    • JobParametersBuilder

      public JobParametersBuilder(JobExplorer jobExplorer)
      パラメーター:
      jobExplorer - JobExplorer は、以前のジョブパラメーター情報を検索するために使用されます。

    • JobParametersBuilder

      public JobParametersBuilder(JobParameters jobParameters)
      コンストラクターをコピーします。指定されたパラメーターでビルダーを初期化します。
      パラメーター:
      jobParameters - ビルダーの初期化に使用される JobParameters インスタンス。

    • JobParametersBuilder

      public JobParametersBuilder(JobParameters jobParameters, JobExplorer jobExplorer)
      コンストラクターをコピーします。指定されたパラメーターでビルダーを初期化します。
      パラメーター:
      jobParameters - ビルダーの初期化に使用される JobParameters インスタンス。
      jobExplorer - JobExplorer は、以前のジョブパラメーター情報を検索するために使用されます。

  • メソッドの詳細

    • addString

      public JobParametersBuilder addString(StringSE key, @NonNull StringSE parameter)
      指定されたキーの新しい識別文字列パラメーターを追加します。
      パラメーター:
      key - パラメーターアクセサー。
      parameter - ランタイムパラメーター。null であってはなりません。
      戻り値:
      このオブジェクトへの参照。

    • addString

      public JobParametersBuilder addString(StringSE key, @NonNull StringSE parameter, boolean identifying)
      指定されたキーに新しい文字列パラメーターを追加します。
      パラメーター:
      key - パラメーターアクセサー。
      parameter - ランタイムパラメーター。null であってはなりません。
      identifying - は、パラメーターがジョブインスタンスの識別の一部として使用されるかどうかを示します。
      戻り値:
      このオブジェクトへの参照。

    • addDate

      public JobParametersBuilder addDate(StringSE key, @NonNull DateSE parameter)
      指定されたキーの新しい識別 DateSE パラメーターを追加します。
      パラメーター:
      key - パラメーターアクセサー。
      parameter - ランタイムパラメーター。null であってはなりません。
      戻り値:
      このオブジェクトへの参照。

    • addDate

      public JobParametersBuilder addDate(StringSE key, @NonNull DateSE parameter, boolean identifying)
      指定されたキーに新しい DateSE パラメーターを追加します。
      パラメーター:
      key - パラメーターアクセサー。
      parameter - ランタイムパラメーター。null であってはなりません。
      identifying - パラメーターがジョブインスタンスの識別の一部として使用されているかどうかを示します
      戻り値:
      このオブジェクトへの参照。

    • addLocalDate

      public JobParametersBuilder addLocalDate(StringSE key, @NonNull LocalDateSE parameter)
      指定されたキーの新しい識別 LocalDateSE パラメーターを追加します。
      パラメーター:
      key - パラメーター名。
      parameter - ランタイムパラメーター。null であってはなりません。
      戻り値:
      このオブジェクトへの参照。

    • addLocalDate

      public JobParametersBuilder addLocalDate(StringSE key, @NonNull LocalDateSE parameter, boolean identifying)
      指定されたキーに新しい LocalDateSE パラメーターを追加します。
      パラメーター:
      key - パラメーター名。
      parameter - ランタイムパラメーター。null であってはなりません。
      identifying - パラメーターがジョブインスタンスの識別の一部として使用されているかどうかを示します
      戻り値:
      このオブジェクトへの参照。

    • addLocalTime

      public JobParametersBuilder addLocalTime(StringSE key, @NonNull LocalTimeSE parameter)
      指定されたキーの新しい識別 LocalTimeSE パラメーターを追加します。
      パラメーター:
      key - パラメーター名。
      parameter - ランタイムパラメーター。null であってはなりません。
      戻り値:
      このオブジェクトへの参照。

    • addLocalTime

      public JobParametersBuilder addLocalTime(StringSE key, @NonNull LocalTimeSE parameter, boolean identifying)
      指定されたキーに新しい LocalTimeSE パラメーターを追加します。
      パラメーター:
      key - パラメーター名。
      parameter - ランタイムパラメーター。null であってはなりません。
      identifying - パラメーターがジョブインスタンスの識別の一部として使用されているかどうかを示します
      戻り値:
      このオブジェクトへの参照。

    • addLocalDateTime

      public JobParametersBuilder addLocalDateTime(StringSE key, @NonNull LocalDateTimeSE parameter)
      指定されたキーの新しい識別 LocalDateTimeSE パラメーターを追加します。
      パラメーター:
      key - パラメーター名。
      parameter - ランタイムパラメーター。null であってはなりません。
      戻り値:
      このオブジェクトへの参照。

    • addLocalDateTime

      public JobParametersBuilder addLocalDateTime(StringSE key, @NonNull LocalDateTimeSE parameter, boolean identifying)
      指定されたキーに新しい LocalDateTimeSE パラメーターを追加します。
      パラメーター:
      key - パラメーター名。
      parameter - ランタイムパラメーター。null であってはなりません。
      identifying - パラメーターがジョブインスタンスの識別の一部として使用されているかどうかを示します
      戻り値:
      このオブジェクトへの参照。

    • addLong

      public JobParametersBuilder addLong(StringSE key, @NonNull LongSE parameter)
      指定されたキーの新しい識別 LongSE パラメーターを追加します。
      パラメーター:
      key - パラメーターアクセサー。
      parameter - ランタイムパラメーター。null であってはなりません。
      戻り値:
      このオブジェクトへの参照。

    • addLong

      public JobParametersBuilder addLong(StringSE key, @NonNull LongSE parameter, boolean identifying)
      指定されたキーに新しい LongSE パラメーターを追加します。
      パラメーター:
      key - パラメーターアクセサー。
      parameter - ランタイムパラメーター。null であってはなりません。
      identifying - パラメーターがジョブインスタンスの識別の一部として使用されるかどうかを示します。
      戻り値:
      このオブジェクトへの参照。

    • addDouble

      public JobParametersBuilder addDouble(StringSE key, @NonNull DoubleSE parameter)
      指定されたキーの新しい識別 DoubleSE パラメーターを追加します。
      パラメーター:
      key - パラメーターアクセサー。
      parameter - ランタイムパラメーター。null であってはなりません。
      戻り値:
      このオブジェクトへの参照。

    • addDouble

      public JobParametersBuilder addDouble(StringSE key, @NonNull DoubleSE parameter, boolean identifying)
      指定されたキーに新しい DoubleSE パラメーターを追加します。
      パラメーター:
      key - パラメーターアクセサー。
      parameter - ランタイムパラメーター。null であってはなりません。
      identifying - パラメーターがジョブインスタンスの識別の一部として使用されるかどうかを示します。
      戻り値:
      このオブジェクトへの参照。

    • toJobParameters

      public JobParameters toJobParameters()
      このビルダーの現在の状態を取得し、それを JobParameters オブジェクトとして返す変換メソッド。
      戻り値:
      有効な JobParameters オブジェクト。

    • addJobParameter

      public JobParametersBuilder addJobParameter(StringSE key, JobParameter<?> jobParameter)
      指定されたキーに新しい JobParameter を追加します。
      パラメーター:
      key - パラメーターアクセサー。
      jobParameter - ランタイムパラメーター。
      戻り値:
      このオブジェクトへの参照。

    • addJobParameter

      public <T> JobParametersBuilder addJobParameter(StringSE name, @NonNull T value, ClassSE<T> type, boolean identifying)
      ジョブパラメーターを追加します。
      型パラメーター:
      T - パラメーターの型
      パラメーター:
      name - パラメーターの名前
      value - パラメーターの値。null であってはなりません。
      type - パラメーターの型
      identifying - パラメーターが識別している場合は true。それ以外の場合は false
      戻り値:
      このオブジェクトへの参照。
      導入:
      5.0

    • addJobParameter

      public <T> JobParametersBuilder addJobParameter(StringSE name, @NonNull T value, ClassSE<T> type)
      識別ジョブパラメーターを追加します。
      型パラメーター:
      T - パラメーターの型
      パラメーター:
      name - パラメーターの名前
      value - パラメーターの値。null であってはなりません。
      type - パラメーターの型
      戻り値:
      このオブジェクトへの参照。
      導入:
      5.0

    • addJobParameters

      public JobParametersBuilder addJobParameters(JobParameters jobParameters)
      ジョブパラメーターを現在の状態にコピーします。
      パラメーター:
      jobParameters - コピーするパラメーター。
      戻り値:
      このオブジェクトへの参照。

    • getNextJobParameters

      public JobParametersBuilder getNextJobParameters(Job job)
      Job の状態に基づいて JobParameters を初期化します。これは、すべてのパラメーターがビルダーに入力された後に呼び出す必要があります。このビルダインスタンスにすでに設定されているすべてのパラメーターは、ジョブインクリメンタから取得したパラメーターに追加され、同じキーでオーバーライドされます (これは、-next オプションおよび JobOperator.startNextInstance(String) を指定した CommandLineJobRunner と同じ動作です)。
      パラメーター:
      job - JobParameters が構成されているジョブ。
      戻り値:
      このオブジェクトへの参照。
      導入:
      4.0