Package org.springframework.shell.command

Interface CommandRegistration

All Known Implementing Classes:
CommandRegistration.DefaultCommandRegistration
public interface CommandRegistration
Interface defining a command registration endpoint.

  • Method Details

    • getCommand

      String getCommand()
      Gets a command for this registration.
      Returns:
      command

    • getInteractionMode

      InteractionMode getInteractionMode()
      Gets an InteractionMode.
      Returns:
      the interaction mode

    • getGroup

      String getGroup()
      Get group for a command.
      Returns:
      the group

    • isHidden

      boolean isHidden()
      Returns if command is hidden.
      Returns:
      true if command is hidden

    • getDescription

      String getDescription()
      Get description for a command.
      Returns:
      the description

    • getAvailability

      Availability getAvailability()
      Get Availability for a command
      Returns:
      the availability

    • getTarget

      CommandRegistration.TargetInfo getTarget()
      Gets target info.
      Returns:
      the target info

    • getOptions

      List<CommandOption> getOptions()
      Gets an options.
      Returns:
      the options

    • getAliases

      List<CommandAlias> getAliases()
      Gets an aliases.
      Returns:
      the aliases

    • getExitCode

      CommandExitCode getExitCode()
      Gets an exit code.
      Returns:
      the exit code

    • getExceptionResolvers

      List<CommandExceptionResolver> getExceptionResolvers()
      Gets an exception resolvers.
      Returns:
      the exception resolvers

    • builder

      static CommandRegistration.Builder builder()
      Gets a new instance of a CommandRegistration.Builder.
      Returns:
      a new builder instance