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

クラス AbstractCommand

java.lang.ObjectSE
org.springframework.shell.core.command.AbstractCommand
実装済みのインターフェース一覧:
Command
既知の直属サブクラス
Clear、ConsumerCommandAdapter、FunctionCommandAdapter、Help、History、MethodInvokerCommandAdapter、Script、Version
public abstract class AbstractCommand extends ObjectSE implements Command
シェルコマンドの構築に役立つ基本クラス。
作成者:
Janne Valkealahti, Piotr Olaszewski, Mahmoud Ben Hassine

  • コンストラクターの詳細

  • メソッドの詳細

    • getName

      public StringSE getName()
      インターフェースからコピーされた説明: Command
      コマンドの名前を取得します。
      次で指定:
      インターフェース Command の getName 
      戻り値:
      コマンドの名前

    • getGroup

      public StringSE getGroup()
      インターフェースからコピーされた説明: Command
      コマンドのグループを取得します。
      次で指定:
      インターフェース Command の getGroup 
      戻り値:
      コマンドのグループ

    • getDescription

      public StringSE getDescription()
      インターフェースからコピーされた説明: Command
      コマンドの簡単な説明を取得します。
      次で指定:
      インターフェース Command の getDescription 
      戻り値:
      コマンドの説明

    • getHelp

      public StringSE getHelp()
      インターフェースからコピーされた説明: Command
      コマンドのヘルプテキストを取得します。
      次で指定:
      インターフェース Command の getHelp 
      戻り値:
      コマンドのヘルプテキスト

    • isHidden

      public boolean isHidden()
      インターフェースからコピーされた説明: Command
      コマンドが非表示になっているかどうかを確認します。
      次で指定:
      インターフェース Command の isHidden 
      戻り値:
      コマンドが非表示の場合は true、そうでない場合は false

    • getAliases

      public ListSE<StringSE> getAliases()
      インターフェースからコピーされた説明: Command
      コマンドのエイリアスを取得します。
      次で指定:
      インターフェース Command の getAliases 
      戻り値:
      コマンドのエイリアス

    • setAliases

      public void setAliases(ListSE<StringSE> aliases)

    • getOptions

      public ListSE<CommandOption> getOptions()
      インターフェースからコピーされた説明: Command
      コマンドのオプションを取得します。
      次で指定:
      インターフェース Command の getOptions 
      戻り値:
      コマンドのオプション

    • setOptions

      public void setOptions(ListSE<CommandOption> options)

    • getAvailabilityProvider

      public AvailabilityProvider getAvailabilityProvider()
      インターフェースからコピーされた説明: Command
      コマンドの可用性プロバイダーを取得します。デフォルトでは常に利用可能です。
      次で指定:
      インターフェース Command の getAvailabilityProvider 
      戻り値:
      コマンドの可用性プロバイダー

    • setAvailabilityProvider

      public void setAvailabilityProvider(AvailabilityProvider availabilityProvider)

    • getExitStatusExceptionMapper

      public @Nullable ExitStatusExceptionMapper getExitStatusExceptionMapper()

    • setExitStatusExceptionMapper

      public void setExitStatusExceptionMapper(ExitStatusExceptionMapper exitStatusExceptionMapper)

    • getCompletionProvider

      public CompletionProvider getCompletionProvider()
      インターフェースからコピーされた説明: Command
      コマンドの補完プロバイダーを取得します。
      次で指定:
      インターフェース Command の getCompletionProvider 
      戻り値:
      コマンドの補完プロバイダ

    • setCompletionProvider

      public void setCompletionProvider(CompletionProvider completionProvider)

    • execute

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

    • println

      protected void println(StringSE message, CommandContext commandContext)

    • isHelp

      protected boolean isHelp(CommandOption option)

    • doExecute

      public abstract ExitStatus doExecute(CommandContext commandContext) throws ExceptionSE
      例外:
      ExceptionSE

    • equals

      public boolean equals(ObjectSE o)
      オーバーライド:
      クラス ObjectSE の equalsSE 

    • hashCode

      public int hashCode()
      オーバーライド:
      クラス ObjectSE の hashCode