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

インターフェース Command

すべての既知の実装クラス:
AbstractCommand、Clear、ConsumerCommandAdapter、FunctionCommandAdapter、Help、History、MethodInvokerCommandAdapter、Script、Version
関数インターフェース:
これは関数インターフェースであるため、ラムダ式またはメソッド参照の割り当てターゲットとして使用できます。
@FunctionalInterfaceSE public interface Command
作成者:
Eric Bottard, Piotr Olaszewski, Mahmoud Ben Hassine

  • ネストされたクラスの概要

    ネストされたクラス
    修飾子と型
    インターフェース
    説明
    static final class
    Command.Builder
    コマンドを作成するためのビルダー。

  • 方法の概要

    修飾子と型
    メソッド
    説明
    static Command.Builder
    builder()
    コマンドを定義および構築するための Builder の新しいインスタンスを作成して返します。
    ExitStatus
    execute(CommandContext commandContext)
    指定されたコンテキスト内でコマンドを実行します。
    default ListSE<StringSE>
    getAliases()
    コマンドのエイリアスを取得します。
    default AvailabilityProvider
    getAvailabilityProvider()
    コマンドの可用性プロバイダーを取得します。
    default CompletionProvider
    getCompletionProvider()
    コマンドの補完プロバイダーを取得します。
    default StringSE
    getDescription()
    コマンドの簡単な説明を取得します。
    default StringSE
    getGroup()
    コマンドのグループを取得します。
    default StringSE
    getHelp()
    コマンドのヘルプテキストを取得します。
    default StringSE
    getName()
    コマンドの名前を取得します。
    default ListSE<CommandOption>
    getOptions()
    コマンドのオプションを取得します。
    default boolean
    isHidden()
    コマンドが非表示になっているかどうかを確認します。

  • 方法の詳細

    • getName

      default StringSE getName()
      コマンドの名前を取得します。
      戻り値:
      コマンドの名前

    • getDescription

      default StringSE getDescription()
      コマンドの簡単な説明を取得します。
      戻り値:
      コマンドの説明

    • getHelp

      default StringSE getHelp()
      コマンドのヘルプテキストを取得します。
      戻り値:
      コマンドのヘルプテキスト

    • isHidden

      default boolean isHidden()
      コマンドが非表示になっているかどうかを確認します。
      戻り値:
      コマンドが非表示の場合は true、そうでない場合は false

    • getGroup

      default StringSE getGroup()
      コマンドのグループを取得します。
      戻り値:
      コマンドのグループ

    • getAliases

      default ListSE<StringSE> getAliases()
      コマンドのエイリアスを取得します。
      戻り値:
      コマンドのエイリアス

    • getOptions

      default ListSE<CommandOption> getOptions()
      コマンドのオプションを取得します。
      戻り値:
      コマンドのオプション

    • getAvailabilityProvider

      default AvailabilityProvider getAvailabilityProvider()
      コマンドの可用性プロバイダーを取得します。デフォルトでは常に利用可能です。
      戻り値:
      コマンドの可用性プロバイダー

    • getCompletionProvider

      default CompletionProvider getCompletionProvider()
      コマンドの補完プロバイダーを取得します。
      戻り値:
      コマンドの補完プロバイダ

    • execute

      ExitStatus execute(CommandContext commandContext) throws ExceptionSE
      指定されたコンテキスト内でコマンドを実行します。
      パラメーター:
      commandContext - コマンドのコンテキスト
      戻り値:
      コマンドの終了ステータス
      例外:
      ExceptionSE

    • builder

      static Command.Builder builder()
      コマンドを定義および構築するための Builder の新しいインスタンスを作成して返します。

      ビルダーを使用すると、名前、説明、グループ、ヘルプテキスト、エイリアス、実行ロジックなどのコマンドプロパティをカスタマイズできます。

      戻り値:
      コマンドの設定と作成のための新しい Builder インスタンス