Class ExitStatus
- java.lang.Object
- org.springframework.boot.cli.command.status.ExitStatus
public final class ExitStatus extends Object
Encapsulation of the outcome of a command.
Field Summary
Fields Modifier and Type Field Description static ExitStatus
ERROR
Generic "not OK" exit status with non-zero exit code and hangup=true.static ExitStatus
OK
Generic "OK" exit status with zero exit code and hangup=false.
Constructor Summary
Constructors Constructor Description ExitStatus(int code, String name)
Create a newExitStatus
instance.ExitStatus(int code, String name, boolean hangup)
Create a newExitStatus
instance.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getCode()
An exit code appropriate for use inSystem.exit()
.String
getName()
A name describing the outcome.ExitStatus
hangup()
Convert the existing code to a hangup.boolean
isHangup()
Flag to signal that the caller can (or should) hangup.String
toString()
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 newExitStatus
instance.- Parameters:
code
- the exit codename
- the name
ExitStatus
public ExitStatus(int code, String name, boolean hangup)
Create a newExitStatus
instance.- Parameters:
code
- the exit codename
- the namehangup
- true if it is OK for the caller to hangup
Method Detail
getCode
public int getCode()
An exit code appropriate for use inSystem.exit()
.- Returns:
- an exit code
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