org.springframework.boot.cli.command.status

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.

Since:

1.0.0

Author:

Dave Syer

See Also:

OK, ERROR

Field Summary

Fields

Modifier and Type	Field and 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 and Description
ExitStatus(int code, String name) Create a new ExitStatus instance.
ExitStatus(int code, String name, boolean hangup) Create a new ExitStatus instance.

Method Summary

Modifier and Type	Method and Description
int	getCode() An exit code appropriate for use in System.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()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

toString

public String toString()

Overrides:

toString in class Object