Package com.codahale.metrics.health
Class HealthCheck.Result
- java.lang.Object
-
- com.codahale.metrics.health.HealthCheck.Result
-
- Enclosing class:
- HealthCheck
public static class HealthCheck.Result extends java.lang.Object
The result of aHealthCheck
being run. It can be healthy (with an optional message) or unhealthy (with either an error message or a thrown exception).
-
-
Constructor Summary
Constructors Modifier Constructor Description private
Result(boolean isHealthy, java.lang.String message, java.lang.Throwable error)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object o)
java.lang.Throwable
getError()
Returns any exception for the result, ornull
if the result has no exception.java.lang.String
getMessage()
Returns any additional message for the result, ornull
if the result has no message.int
hashCode()
static HealthCheck.Result
healthy()
Returns a healthyHealthCheck.Result
with no additional message.static HealthCheck.Result
healthy(java.lang.String message)
Returns a healthyHealthCheck.Result
with an additional message.static HealthCheck.Result
healthy(java.lang.String message, java.lang.Object... args)
Returns a healthyHealthCheck.Result
with a formatted message.boolean
isHealthy()
Returnstrue
if the result indicates the component is healthy;false
otherwise.java.lang.String
toString()
static HealthCheck.Result
unhealthy(java.lang.String message)
Returns an unhealthyHealthCheck.Result
with the given message.static HealthCheck.Result
unhealthy(java.lang.String message, java.lang.Object... args)
Returns an unhealthyHealthCheck.Result
with a formatted message.static HealthCheck.Result
unhealthy(java.lang.Throwable error)
Returns an unhealthyHealthCheck.Result
with the given error.
-
-
-
Field Detail
-
HEALTHY
private static final HealthCheck.Result HEALTHY
-
PRIME
private static final int PRIME
- See Also:
- Constant Field Values
-
healthy
private final boolean healthy
-
message
private final java.lang.String message
-
error
private final java.lang.Throwable error
-
-
Method Detail
-
healthy
public static HealthCheck.Result healthy()
Returns a healthyHealthCheck.Result
with no additional message.- Returns:
- a healthy
HealthCheck.Result
with no additional message
-
healthy
public static HealthCheck.Result healthy(java.lang.String message)
Returns a healthyHealthCheck.Result
with an additional message.- Parameters:
message
- an informative message- Returns:
- a healthy
HealthCheck.Result
with an additional message
-
healthy
public static HealthCheck.Result healthy(java.lang.String message, java.lang.Object... args)
Returns a healthyHealthCheck.Result
with a formatted message. Message formatting follows the same rules asString.format(String, Object...)
.- Parameters:
message
- a message formatargs
- the arguments apply to the message format- Returns:
- a healthy
HealthCheck.Result
with an additional message - See Also:
String.format(String, Object...)
-
unhealthy
public static HealthCheck.Result unhealthy(java.lang.String message)
Returns an unhealthyHealthCheck.Result
with the given message.- Parameters:
message
- an informative message describing how the health check failed- Returns:
- an unhealthy
HealthCheck.Result
with the given message
-
unhealthy
public static HealthCheck.Result unhealthy(java.lang.String message, java.lang.Object... args)
Returns an unhealthyHealthCheck.Result
with a formatted message. Message formatting follows the same rules asString.format(String, Object...)
.- Parameters:
message
- a message formatargs
- the arguments apply to the message format- Returns:
- an unhealthy
HealthCheck.Result
with an additional message - See Also:
String.format(String, Object...)
-
unhealthy
public static HealthCheck.Result unhealthy(java.lang.Throwable error)
Returns an unhealthyHealthCheck.Result
with the given error.- Parameters:
error
- an exception thrown during the health check- Returns:
- an unhealthy
HealthCheck.Result
with the given error
-
isHealthy
public boolean isHealthy()
Returnstrue
if the result indicates the component is healthy;false
otherwise.- Returns:
true
if the result indicates the component is healthy
-
getMessage
public java.lang.String getMessage()
Returns any additional message for the result, ornull
if the result has no message.- Returns:
- any additional message for the result, or
null
-
getError
public java.lang.Throwable getError()
Returns any exception for the result, ornull
if the result has no exception.- Returns:
- any exception for the result, or
null
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-