AbstractStep (Spring Batch API)

java.lang.Object
- org.springframework.batch.core.step.AbstractStep

実装されたすべてのインターフェース:
Step, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean
既知の直属サブクラス
DecisionStep, DelegateStep, FlowStep, JobStep, PartitionStep, TaskletStep
```
public abstract class AbstractStep
extends java.lang.Object
implements Step, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.BeanNameAware
```
リスナーの登録や呼び出しなど、サブクラスに共通の動作を提供する Step 実装。
作成者:
Dave Syer, Ben Hale, Robert Kasanicky, Michael Minella, Chris Schaefer, Mahmoud Ben Hassine

フィールドサマリー
- インターフェース org.springframework.batch.core.Step から継承されたフィールド
  STEP_TYPE_KEY

コンストラクターのサマリー

コンストラクター
コンストラクターと説明
`AbstractStep()` デフォルトコンストラクター。
`AbstractStep(java.lang.String name)` name プロパティのみを設定するための便利なコンストラクター。

メソッドのサマリー

すべてのメソッドインスタンスメソッド抽象メソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`afterPropertiesSet()`
`protected void`	`close(ExecutionContext ctx)` リソースを閉じるか解放するために、ステップの最後（finally ブロックの最後）でコラボレーターにコールバックを提供するサブクラスの拡張ポイント。
`protected abstract void`	`doExecute(StepExecution stepExecution)` ビジネスロジックを実行するサブクラスの拡張ポイント。
`protected void`	`doExecutionRegistration(StepExecution stepExecution)` `StepScope` によるプロパティ解決のために `StepExecution` を登録します
`protected void`	`doExecutionRelease()` 最新の `StepExecution` をリリース
`void`	`execute(StepExecution stepExecution)` ステップ実行ロジックのテンプレートメソッド - リソースの初期化（`open(ExecutionContext)`）、実行ロジック（`doExecute(StepExecution)`）およびリソースのクローズ（`close(ExecutionContext)`）の抽象メソッドを呼び出します。
`protected StepExecutionListener`	`getCompositeListener()`
`protected JobRepository`	`getJobRepository()`
`java.lang.String`	`getName()`
`int`	`getStartLimit()`
`boolean`	`isAllowStartIfComplete()`
`protected void`	`open(ExecutionContext ctx)` ステップを開始するときにサブクラスがコラボレーターにコールバックを提供し、リソースを開いたり取得したりするための拡張ポイント。
`void`	`registerStepExecutionListener(StepExecutionListener listener)` ステップ実行の適切な段階で、コールバックのステップリスナーを登録します。
`void`	`setAllowStartIfComplete(boolean allowStartIfComplete)` ステップがすでに完了している場合にステップを再開するかどうかを決定するフラグのパブリック setter。
`void`	`setBeanName(java.lang.String name)` name プロパティがまだ設定されていない場合は設定します。
`void`	`setJobRepository(JobRepository jobRepository)` `JobRepository` のパブリック setter。
`void`	`setName(java.lang.String name)` name プロパティを設定します。
`void`	`setStartLimit(int startLimit)` startLimit のパブリック setter。
`void`	`setStepExecutionListeners(StepExecutionListener[] listeners)` 各オブジェクトをリスナーとして登録します。
`java.lang.String`	`toString()`

クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- コンストラクターの詳細
  - AbstractStep
```
public AbstractStep()
```
    デフォルトコンストラクター。
  - AbstractStep
```
public AbstractStep(java.lang.String name)
```
    name プロパティのみを設定するための便利なコンストラクター。
    パラメーター:
    name - ステップの名前
- メソッドの詳細
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws java.lang.Exception
```
    次で指定:
    インターフェース org.springframework.beans.factory.InitializingBean の afterPropertiesSet
    例外:
    java.lang.Exception
  - getName
```
public java.lang.String getName()
```
    次で指定:
    インターフェース Step の getName
    戻り値:
    このステップの名前。
  - setName
```
public void setName(java.lang.String name)
```
    name プロパティを設定します。このオブジェクトが Spring Bean の場合、常にデフォルト値をオーバーライドします。
    パラメーター:
    name - Step の名前。
    関連事項:
    setBeanName(java.lang.String)
  - setBeanName
```
public void setBeanName(java.lang.String name)
```
    name プロパティがまだ設定されていない場合は設定します。Spring コンテナー内のコールバックの順序のため、name プロパティが存在する場合は、最初に設定されます。Bean 定義の継承には注意が必要です。親 Bean に名前がある場合、その子にも明示的な名前が必要です。そうでない場合、一意ではありません。
    次で指定:
    インターフェース org.springframework.beans.factory.BeanNameAware の setBeanName
    関連事項:
    BeanNameAware.setBeanName(java.lang.String)
  - getStartLimit
```
public int getStartLimit()
```
    次で指定:
    インターフェース Step の getStartLimit
    戻り値:
    同じ識別子でジョブを開始できる回数。
  - setStartLimit
```
public void setStartLimit(int startLimit)
```
    startLimit のパブリック setter。
    パラメーター:
    startLimit - 設定する startLimit
  - isAllowStartIfComplete
```
public boolean isAllowStartIfComplete()
```
    次で指定:
    インターフェース Step の isAllowStartIfComplete
    戻り値:
    すでに完了としてマークされているステップを再び開始できる場合は true。
  - setAllowStartIfComplete
```
public void setAllowStartIfComplete(boolean allowStartIfComplete)
```
    ステップがすでに完了している場合にステップを再開するかどうかを決定するフラグのパブリック setter。デフォルトは false です。
    パラメーター:
    allowStartIfComplete - 設定するフラグの値
  - doExecute
```
protected abstract void doExecute(StepExecution stepExecution)
                           throws java.lang.Exception
```
    ビジネスロジックを実行するサブクラスの拡張ポイント。サブクラスは、戻る前に StepExecution に ExitStatus を設定する必要があります。
    パラメーター:
    stepExecution - 現在のステップのコンテキスト
    例外:
    java.lang.Exception - 実装によってスローされたチェック済み例外
  - open
```
protected void open(ExecutionContext ctx)
             throws java.lang.Exception
```
    ステップを開始するときにサブクラスがコラボレーターにコールバックを提供し、リソースを開いたり取得したりするための拡張ポイント。デフォルトでは何もしません。
    パラメーター:
    ctx - 使用する ExecutionContext
    例外:
    java.lang.Exception - 実装によってスローされたチェック済み例外
  - close
```
protected void close(ExecutionContext ctx)
              throws java.lang.Exception
```
    リソースを閉じるか解放するために、ステップの最後（finally ブロックの最後）でコラボレーターにコールバックを提供するサブクラスの拡張ポイント。デフォルトでは何もしません。
    パラメーター:
    ctx - 使用する ExecutionContext
    例外:
    java.lang.Exception - 実装によってスローされたチェック済み例外
  - execute
```
public final void execute(StepExecution stepExecution)
                   throws JobInterruptedException,
                          UnexpectedJobExecutionException
```
    ステップ実行ロジックのテンプレートメソッド - リソースの初期化（open(ExecutionContext)）、実行ロジック（doExecute(StepExecution)）およびリソースのクローズ（close(ExecutionContext)）の抽象メソッドを呼び出します。
    次で指定:
    インターフェース Step の execute
    パラメーター:
    stepExecution - 実行するステップを表すエンティティ
    例外:
    JobInterruptedException - ステップが外部で中断された場合
    UnexpectedJobExecutionException
  - doExecutionRelease
```
protected void doExecutionRelease()
```
    最新の StepExecution をリリース
  - doExecutionRegistration
```
protected void doExecutionRegistration(StepExecution stepExecution)
```
    StepScope によるプロパティ解決のために StepExecution を登録します
    パラメーター:
    stepExecution - StepScoped Bean を水和するときに使用する StepExecution
  - registerStepExecutionListener
```
public void registerStepExecutionListener(StepExecutionListener listener)
```
    ステップ実行の適切な段階で、コールバックのステップリスナーを登録します。
    パラメーター:
    listener - StepExecutionListener
  - setStepExecutionListeners
```
public void setStepExecutionListeners(StepExecutionListener[] listeners)
```
    各オブジェクトをリスナーとして登録します。
    パラメーター:
    listeners - 既知の型のリスナーオブジェクトの配列。
  - getCompositeListener
```
protected StepExecutionListener getCompositeListener()
```
    戻り値:
    登録されたすべてのリスナーに委譲する複合リスナー。
  - setJobRepository
```
public void setJobRepository(JobRepository jobRepository)
```
    JobRepository のパブリック setter。
    パラメーター:
    jobRepository - 必須の依存関係です（デフォルトなし）。
  - getJobRepository
```
protected JobRepository getJobRepository()
```
  - toString
```
public java.lang.String toString()
```
    オーバーライド:
    クラス java.lang.Object の toString

クラス AbstractStep

フィールドサマリー

インターフェース org.springframework.batch.core.Step から継承されたフィールド

コンストラクターのサマリー

メソッドのサマリー

クラス java.lang.Object から継承されたメソッド

コンストラクターの詳細

AbstractStep

AbstractStep

メソッドの詳細

afterPropertiesSet

getName

setName

setBeanName

getStartLimit

setStartLimit

isAllowStartIfComplete

setAllowStartIfComplete

doExecute

open

close

execute

doExecutionRelease

doExecutionRegistration

registerStepExecutionListener

setStepExecutionListeners

getCompositeListener

setJobRepository

getJobRepository

toString