Package org.springframework.shell.command

Interface CommandHandlingResult

All Known Implementing Classes:
CommandHandlingResult.DefaultHandlingResult
public interface CommandHandlingResult
Holder for handling some processing, typically with CommandExceptionResolver.

  • Method Details

    • message

      @Nullable String message()
      Gets a message for this HandlingResult.
      Returns:
      a message

    • exitCode

      Integer exitCode()
      Gets an exit code for this HandlingResult. Exit code only has meaning if shell is in non-interactive mode.
      Returns:
      an exit code

    • isPresent

      boolean isPresent()
      Indicate whether this HandlingResult has a result.
      Returns:
      true if result exist

    • isEmpty

      boolean isEmpty()
      Indicate whether this HandlingResult does not have a result.
      Returns:
      true if result doesn't exist

    • empty

      static CommandHandlingResult empty()
      Gets an empty instance of HandlingResult.
      Returns:
      empty instance of HandlingResult

    • of

      static CommandHandlingResult of(@Nullable String message)
      Gets an instance of HandlingResult.
      Parameters:
      message - the message
      Returns:
      instance of HandlingResult

    • of

      static CommandHandlingResult of(@Nullable String message, Integer exitCode)
      Gets an instance of HandlingResult.
      Parameters:
      message - the message
      exitCode - the exit code
      Returns:
      instance of HandlingResult