パッケージ org.springframework.shell.command

インターフェース CommandRegistration.Builder

すべての既知の実装クラス:
CommandRegistration.BaseBuilder, CommandRegistration.DefaultBuilder
含まれているインターフェース:
CommandRegistration
public static interface CommandRegistration.Builder
CommandRegistration のビルダーインターフェース。

  • メソッドの詳細

    • command

      CommandRegistration.Builder command(StringSE... commands)
      この登録で使用するコマンドを定義します。基本的に、メインコマンドとサブコマンドの完全なセットを定義します。完全なコマンドが 1 つの文字列で定義されているか、「単語」が分割されて空白でトリミングされている複数の文字列で定義されているかは問題ではありません。command subcommand1 subcommand2,... の結果が得られます。
      パラメーター:
      commands - コマンド
      戻り値:
      連鎖のためのビルダー

    • interactionMode

      CommandRegistration.Builder interactionMode(InteractionMode mode)
      コマンドに InteractionMode を定義します。
      パラメーター:
      mode - 相互作用モード
      戻り値:
      連鎖のためのビルダー

    • description

      CommandRegistration.Builder description(StringSE description)
      コマンドの説明テキストを定義します。
      パラメーター:
      description - 説明テキスト
      戻り値:
      連鎖のためのビルダー

    • availability

      CommandRegistration.Builder availability(SupplierSE<Availability> availability)
      コマンドの Availability サプライヤーを定義します。
      パラメーター:
      availability - 可用性
      戻り値:
      連鎖のためのビルダー

    • group

      CommandRegistration.Builder group(StringSE group)
      コマンドのグループを定義します。
      パラメーター:
      group - グループ
      戻り値:
      連鎖のためのビルダー

    • hidden

      CommandRegistration.Builder hidden()
      非表示にするコマンドを定義します。
      戻り値:
      連鎖のためのビルダー
      関連事項:

    • hidden

      CommandRegistration.Builder hidden(boolean hidden)
      指定されたフラグによって非表示になるコマンドを定義します。
      パラメーター:
      hidden - 隠されたフラグ
      戻り値:
      連鎖のためのビルダー

    • defaultOptionNameModifier

      CommandRegistration.Builder defaultOptionNameModifier(FunctionSE<StringSE,StringSE> modifier)
      グローバルオプション名修飾子を提供します。長い名前を変更するためのすべてのオプションとともに使用されます。通常の使用例は、命名規則を適用することです。つまり、すべての名前に snake-case を使用します。
      パラメーター:
      modifier - オプション名を変更する修飾子に
      戻り値:
      連鎖のためのビルダー

    • withOption

      CommandRegistration.OptionSpec withOption()
      このコマンドが使用するオプションを定義します。複数回使用できます。
      戻り値:
      連鎖のオプション仕様

    • withTarget

      CommandRegistration.TargetSpec withTarget()
      このコマンドが実行するターゲットを定義します
      戻り値:
      連鎖のターゲット仕様

    • withAlias

      CommandRegistration.AliasSpec withAlias()
      このコマンドが実行するエイリアスを定義します
      戻り値:
      連鎖のエイリアス仕様

    • withExitCode

      CommandRegistration.ExitCodeSpec withExitCode()
      このコマンドが実行する終了コードを定義します
      戻り値:
      連鎖の終了コード仕様

    • withErrorHandling

      CommandRegistration.ErrorHandlingSpec withErrorHandling()
      このコマンドで使用するエラー処理を定義します
      戻り値:
      チェーンのエラー処理仕様

    • withHelpOptions

      CommandRegistration.HelpOptionsSpec withHelpOptions()
      このコマンドで使用するヘルプオプションを定義します。
      戻り値:
      ヘルプオプションチェーンの仕様

    • build

      CommandRegistration build()
      CommandRegistration をビルドします。
      戻り値:
      コマンド登録