org.apache.sling.hc.api

Class Result

java.lang.Object

org.apache.sling.hc.api.Result

All Implemented Interfaces:

java.lang.Iterable<ResultLog.Entry>

public class Result
extends java.lang.Object
implements java.lang.Iterable<ResultLog.Entry>

The result of executing a HealthCheck

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Result.Status

Field Summary

Fields

Modifier and Type	Field and Description
protected ResultLog	resultLog

Constructor Summary

Constructors

Constructor and Description
Result(Result.Status s, java.lang.String explanation) Build a single-value Result
Result(Result.Status s, java.lang.String explanation, java.lang.Exception e) Build a single-value Result with exception
Result(ResultLog log) Build a a Result based on a ResultLog, which can provide more details than a single-value Result.

Method Summary

Modifier and Type	Method and Description
Result.Status	getStatus() Return our Status
boolean	isOk() True if our status is OK - provides a convenient way of checking that.
java.util.Iterator<ResultLog.Entry>	iterator() Return an Iterator on the entries of our ResultLog
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

resultLog

protected final ResultLog resultLog

Constructor Detail

Result

public Result(Result.Status s,
              java.lang.String explanation)

Build a single-value Result

Parameters:

s - if lower than OK, our status is set to OK

Result

public Result(Result.Status s,
              java.lang.String explanation,
              java.lang.Exception e)

Build a single-value Result with exception

Parameters:

s - if lower than OK, our status is set to OK

Result

public Result(ResultLog log)

Build a a Result based on a ResultLog, which can provide more details than a single-value Result.

Method Detail

isOk

public boolean isOk()

True if our status is OK - provides a convenient way of checking that.

getStatus

public Result.Status getStatus()

Return our Status

iterator

public java.util.Iterator<ResultLog.Entry> iterator()

Return an Iterator on the entries of our ResultLog

Specified by:

iterator in interface java.lang.Iterable<ResultLog.Entry>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object