org.springframework.boot.actuate.health

Class Status

java.lang.Object

org.springframework.boot.actuate.health.Status

public final class Status
extends Object

Value object to express state of a component or subsystem.

Status provides convenient constants for commonly used states like UP, DOWN or OUT_OF_SERVICE.

Custom states can also be created and used throughout the Spring Boot Health subsystem.

Since:

1.1.0

Author:

Christian Dupuis

Field Summary

Fields

Modifier and Type	Field and Description
static Status	DOWN Convenient constant value representing down state
static Status	OUT_OF_SERVICE Convenient constant value representing out-of-service state
static Status	UNKNOWN Convenient constant value representing unknown state
static Status	UP Convenient constant value representing up state

Constructor Summary

Constructors

Constructor and Description
Status(String code) Create a new Status instance with the given code and an empty description.
Status(String code, String description) Create a new Status instance with the given code and description.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCode()
String	getDescription()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

UNKNOWN

public static final Status UNKNOWN

Convenient constant value representing unknown state

UP

public static final Status UP

Convenient constant value representing up state

DOWN

public static final Status DOWN

Convenient constant value representing down state

OUT_OF_SERVICE

public static final Status OUT_OF_SERVICE

Convenient constant value representing out-of-service state

Constructor Detail

Status

public Status(String code)

Create a new Status instance with the given code and an empty description.

Parameters:

code - the status code

Status

public Status(String code,
      String description)

Create a new Status instance with the given code and description.

Parameters:

code - the status code

description - a description of the status

Method Detail

getCode

public String getCode()

Returns:

the code for this status

getDescription

public String getDescription()

Returns:

the description of this status

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object