CommandRunner (Spring Boot Docs 2.1.11.RELEASE API)

java.lang.ObjectSE
- org.springframework.boot.cli.command.CommandRunner

実装済みのインターフェース一覧:
IterableSE<Command>
```
public class CommandRunner
extends ObjectSE
implements IterableSE<Command>
```
Command の実行に使用されるメインクラス。
導入:
1.0.0
作成者:
Phillip Webb
関連事項:
addCommand(Command), runAndHandleErrors(String[])

コンストラクター概要
コンストラクター
コンストラクターと説明
CommandRunner(StringSE name)
新しい CommandRunner インスタンスを作成します。

コンストラクター
コンストラクターと説明
`CommandRunner(StringSE name)` 新しい `CommandRunner` インスタンスを作成します。

方法の概要

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`addCommand(Command command)` 指定されたコマンドを追加します。
`void`	`addCommands(IterableSE<Command> commands)` 指定されたコマンドを追加します。
`protected void`	`afterRun(Command command)` コマンドの実行後に呼び出されるサブクラスフック。
`protected void`	`beforeRun(Command command)` コマンドが実行される前に呼び出されるサブクラスフック。
`protected boolean`	`errorMessage(StringSE message)`
`Command`	`findCommand(StringSE name)` 名前でコマンドを検索します。
`protected ListSE<Command>`	`getCommands()`
`StringSE`	`getName()` ランナーの名前または空の文字列を返します。
`boolean`	`isOptionCommand(Command command)` 指定されたコマンドがオプションコマンドかどうかを返します。
`IteratorSE<Command>`	`iterator()`
`protected void`	`printStackTrace(ExceptionSE ex)`
`protected ExitStatus`	`run(StringSE... args)` 引数を解析し、適切なコマンドを実行します。
`int`	`runAndHandleErrors(StringSE... args)` 適切なハンドルとエラーを実行します。
`void`	`setHiddenCommands(ClassSE<?>... commandClasses)` 非表示にするコマンドクラスを設定します（つまり
`void`	`setOptionCommands(ClassSE<?>... commandClasses)` オプションコマンドと見なされるコマンドクラスを設定します。
`protected void`	`showUsage()`

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

インターフェース java.lang.IterableSE から継承されたメソッド
forEachSE, spliteratorSE

- コンストラクターの詳細
  - CommandRunner
```
public CommandRunner(StringSE name)
```
    新しい CommandRunner インスタンスを作成します。
    パラメーター:
    name - ランナーの名前または null
- メソッドの詳細
  - getName
```
public StringSE getName()
```
    ランナーの名前または空の文字列を返します。空でない名前には、末尾のスペース文字が含まれるため、プレフィックスとして使用できます。
    戻り値:
    ランナーの名前
  - addCommands
```
public void addCommands(IterableSE<Command> commands)
```
    指定されたコマンドを追加します。
    パラメーター:
    commands - 追加するコマンド
  - addCommand
```
public void addCommand(Command command)
```
    指定されたコマンドを追加します。
    パラメーター:
    command - 追加するコマンド。
  - setOptionCommands
```
public void setOptionCommands(ClassSE<?>... commandClasses)
```
    オプションコマンドと見なされるコマンドクラスを設定します。オプションコマンドは特別な型のコマンドで、通常はオプションであるかのように提示する方が理にかなっています。たとえば、"--version" です。
    パラメーター:
    commandClasses - オプションコマンドのクラス。
    関連事項:
    isOptionCommand(Command)
  - setHiddenCommands
```
public void setHiddenCommands(ClassSE<?>... commandClasses)
```
    非表示にする必要があるコマンドクラスを設定します（つまり、実行されますが、使用可能なコマンドリストには表示されません）。
    パラメーター:
    commandClasses - 隠しコマンドのクラス
  - isOptionCommand
```
public boolean isOptionCommand(Command command)
```
    指定されたコマンドがオプションコマンドかどうかを返します。
    パラメーター:
    command - テストするコマンド
    戻り値:
    コマンドがオプションコマンドの場合は true
    関連事項:
    setOptionCommands(Class...)
  - iterator
```
public IteratorSE<Command> iterator()
```
    次で指定:
    インターフェース IterableSE<Command> 内の iteratorSE
  - getCommands
```
protected final ListSE<Command> getCommands()
```
  - findCommand
```
public Command findCommand(StringSE name)
```
    名前でコマンドを検索します。
    パラメーター:
    name - コマンドの名前
    戻り値:
    コマンド、または null が見つからない場合
  - runAndHandleErrors
```
public int runAndHandleErrors(StringSE... args)
```
    適切なハンドルとエラーを実行します。
    パラメーター:
    args - 入力引数
    戻り値:
    戻りステータスコード (非 Boot はエラーを示すために使用されます)
  - run
```
protected ExitStatus run(StringSE... args)
                  throws ExceptionSE
```
    引数を解析し、適切なコマンドを実行します。
    パラメーター:
    args - 引数
    戻り値:
    コマンドの結果
    例外:
    ExceptionSE - コマンドが失敗した場合
  - beforeRun
```
protected void beforeRun(Command command)
```
    コマンドが実行される前に呼び出されるサブクラスフック。
    パラメーター:
    command - 実行しようとしているコマンド
  - afterRun
```
protected void afterRun(Command command)
```
    コマンドの実行後に呼び出されるサブクラスフック。
    パラメーター:
    command - 実行したコマンド
  - errorMessage
```
protected boolean errorMessage(StringSE message)
```
  - showUsage
```
protected void showUsage()
```
  - printStackTrace
```
protected void printStackTrace(ExceptionSE ex)
```

クラス CommandRunner

コンストラクター概要

方法の概要

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

インターフェース java.lang.IterableSE から継承されたメソッド

コンストラクターの詳細

CommandRunner

メソッドの詳細

getName

addCommands

addCommand

setOptionCommands

setHiddenCommands

isOptionCommand

iterator

getCommands

findCommand

runAndHandleErrors

run

beforeRun

afterRun

errorMessage

showUsage

printStackTrace