クラス CommandRegistration.BaseBuilder

メソッドの詳細

• command

  public CommandRegistration.Builder command(StringSE... commands)

  インターフェースからコピーされた説明: CommandRegistration.Builder

  この登録で使用するコマンドを定義します。基本的に、メインコマンドとサブコマンドの完全なセットを定義します。完全なコマンドが 1 つの文字列で定義されているか、「単語」が分割されて空白でトリミングされている複数の文字列で定義されているかは問題ではありません。command subcommand1 subcommand2,... の結果が得られます。

  次で指定:

  インターフェース CommandRegistration.Builder の command 

  パラメーター:

  commands - コマンド

  戻り値:

  連鎖のためのビルダー

• interactionMode

  public CommandRegistration.Builder interactionMode(InteractionMode mode)

  インターフェースからコピーされた説明: CommandRegistration.Builder

  コマンドに InteractionMode を定義します。

  次で指定:

  インターフェース CommandRegistration.Builder の interactionMode 

  パラメーター:

  mode - 相互作用モード

  戻り値:

  連鎖のためのビルダー

• description

  public CommandRegistration.Builder description(StringSE description)

  インターフェースからコピーされた説明: CommandRegistration.Builder

  コマンドの説明テキストを定義します。

  次で指定:

  インターフェース CommandRegistration.Builder の description 

  パラメーター:

  description - 説明テキスト

  戻り値:

  連鎖のためのビルダー

• group

  public CommandRegistration.Builder group(StringSE group)

  インターフェースからコピーされた説明: CommandRegistration.Builder

  コマンドのグループを定義します。

  次で指定:

  インターフェース CommandRegistration.Builder の group 

  パラメーター:

  group - グループ

  戻り値:

  連鎖のためのビルダー

• hidden

  public CommandRegistration.Builder hidden()

  インターフェースからコピーされた説明: CommandRegistration.Builder

  非表示にするコマンドを定義します。

  次で指定:

  インターフェース CommandRegistration.Builder の hidden 

  戻り値:

  連鎖のためのビルダー

  関連事項:

  • CommandRegistration.Builder.hidden(boolean)

• hidden

  public CommandRegistration.Builder hidden(boolean hidden)

  インターフェースからコピーされた説明: CommandRegistration.Builder

  指定されたフラグによって非表示になるコマンドを定義します。

  次で指定:

  インターフェース CommandRegistration.Builder の hidden 

  パラメーター:

  hidden - 隠されたフラグ

  戻り値:

  連鎖のためのビルダー

• availability

  public CommandRegistration.Builder availability(SupplierSE<Availability> availability)

  インターフェースからコピーされた説明: CommandRegistration.Builder

  コマンドの Availability サプライヤーを定義します。

  次で指定:

  インターフェース CommandRegistration.Builder の availability 

  パラメーター:

  availability - 可用性

  戻り値:

  連鎖のためのビルダー

• defaultOptionNameModifier

  public CommandRegistration.Builder defaultOptionNameModifier(FunctionSE<StringSE,StringSE> modifier)

  インターフェースからコピーされた説明: CommandRegistration.Builder

  グローバルオプション名修飾子を提供します。長い名前を変更するためのすべてのオプションとともに使用されます。通常の使用例は、命名規則を適用することです。つまり、すべての名前に snake-case を使用します。

  次で指定:

  インターフェース CommandRegistration.Builder の defaultOptionNameModifier 

  パラメーター:

  modifier - オプション名を変更する修飾子に

  戻り値:

  連鎖のためのビルダー

• withOption

  public CommandRegistration.OptionSpec withOption()

  インターフェースからコピーされた説明: CommandRegistration.Builder

  このコマンドが使用するオプションを定義します。複数回使用できます。

  次で指定:

  インターフェース CommandRegistration.Builder の withOption 

  戻り値:

  連鎖のオプション仕様

• withTarget

  public CommandRegistration.TargetSpec withTarget()

  インターフェースからコピーされた説明: CommandRegistration.Builder

  このコマンドが実行するターゲットを定義します

  次で指定:

  インターフェース CommandRegistration.Builder の withTarget 

  戻り値:

  連鎖のターゲット仕様

• withAlias

  public CommandRegistration.AliasSpec withAlias()

  インターフェースからコピーされた説明: CommandRegistration.Builder

  このコマンドが実行するエイリアスを定義します

  次で指定:

  インターフェース CommandRegistration.Builder の withAlias 

  戻り値:

  連鎖のエイリアス仕様

• withExitCode

  public CommandRegistration.ExitCodeSpec withExitCode()

  インターフェースからコピーされた説明: CommandRegistration.Builder

  このコマンドが実行する終了コードを定義します

  次で指定:

  インターフェース CommandRegistration.Builder の withExitCode 

  戻り値:

  連鎖の終了コード仕様

• withErrorHandling

  public CommandRegistration.ErrorHandlingSpec withErrorHandling()

  インターフェースからコピーされた説明: CommandRegistration.Builder

  このコマンドで使用するエラー処理を定義します

  次で指定:

  インターフェース CommandRegistration.Builder の withErrorHandling 

  戻り値:

  チェーンのエラー処理仕様

• withHelpOptions

  public CommandRegistration.HelpOptionsSpec withHelpOptions()

  インターフェースからコピーされた説明: CommandRegistration.Builder

  このコマンドで使用するヘルプオプションを定義します。

  次で指定:

  インターフェース CommandRegistration.Builder の withHelpOptions 

  戻り値:

  ヘルプオプションチェーンの仕様

• build

  public CommandRegistration build()

  インターフェースからコピーされた説明: CommandRegistration.Builder

  CommandRegistration をビルドします。

  次で指定:

  インターフェース CommandRegistration.Builder の build 

  戻り値:

  コマンド登録