org.springframework.boot.cli.command.status

Class ExitStatus



  • public final class ExitStatus
    extends Object
    Encapsulation of the outcome of a command.
    Author:
    Dave Syer
    See Also:
    OK, ERROR
    • Field Detail

      • OK

        public static final ExitStatus OK
        Generic "OK" exit status with zero exit code and hangup=false.
      • ERROR

        public static final ExitStatus ERROR
        Generic "not OK" exit status with non-zero exit code and hangup=true.
    • Constructor Detail

      • ExitStatus

        public ExitStatus(int code,
                          String name)
        Create a new ExitStatus instance.
        Parameters:
        code - the exit code
        name - the name
      • ExitStatus

        public ExitStatus(int code,
                          String name,
                          boolean hangup)
        Create a new ExitStatus instance.
        Parameters:
        code - the exit code
        name - the name
        hangup - true if it is OK for the caller to hangup
    • Method Detail

      • getCode

        public int getCode()
        An exit code appropriate for use in System.exit().
        Returns:
        an exit code
      • getName

        public String getName()
        A name describing the outcome.
        Returns:
        a name
      • isHangup

        public boolean isHangup()
        Flag to signal that the caller can (or should) hangup. A server process with non-daemon threads should set this to false.
        Returns:
        the flag
      • hangup

        public ExitStatus hangup()
        Convert the existing code to a hangup.
        Returns:
        a new ExitStatus with hangup=true