org.apache.sling.hc.api

Class ResultLog

java.lang.Object

org.apache.sling.hc.api.ResultLog

All Implemented Interfaces:

java.lang.Iterable<ResultLog.Entry>

Direct Known Subclasses:

FormattingResultLog

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

The log of a Result, allows for providing multiple lines of information which are aggregated as a single Result.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResultLog.Entry An entry in this log

Constructor Summary

Constructors

Constructor and Description
ResultLog() Build a log.
ResultLog(ResultLog log) Create a copy of the result log

Method Summary

Modifier and Type	Method and Description
ResultLog	add(ResultLog.Entry e) Add an entry to this log.
Result.Status	getAggregateStatus() Return our aggregate status, i.e.
java.util.Iterator<ResultLog.Entry>	iterator() Return an Iterator on our entries
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ResultLog

public ResultLog()

Build a log. Initial aggregate status is set to WARN, as an empty log is not considered ok. That's reset to OK before adding the first log entry, and then the status aggregation rules take over.

ResultLog

public ResultLog(ResultLog log)

Create a copy of the result log

Method Detail

add

public ResultLog add(ResultLog.Entry e)

Add an entry to this log. The aggregate status of this is set to the highest of the current aggregate status and the new Entry's status

iterator

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

Return an Iterator on our entries

Specified by:

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

getAggregateStatus

public Result.Status getAggregateStatus()

Return our aggregate status, i.e. the highest status of the entries added to this log. Starts at OK for an empty ResultLog, so cannot be lower than that.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object