com.google.jenkins.plugins.health.lib

Class DerivedPageComponentReport<Value>

java.lang.Object

com.google.jenkins.plugins.health.lib.DerivedPageComponentReport<Value>

Type Parameters:

Value - Result or product of the derivation, other than the indication if it is successfully produced.

Direct Known Subclasses:

HealthCheckReport

@ExportedBean
public class DerivedPageComponentReport<Value>
extends Object

A tuple of a Result derivation success and Value outcome.

Constructor Summary

Constructors

Constructor and Description
DerivedPageComponentReport(hudson.model.Result result, Value value)

Method Summary

Methods

Modifier and Type	Method and Description
hudson.model.Result	getResult()
Value	getValue()

Methods inherited from class java.lang.Object

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

Constructor Detail

DerivedPageComponentReport

public DerivedPageComponentReport(hudson.model.Result result,
                          Value value)

Parameters:

result - Result indicating if derivation of value is successful.

value - Value calculated for this component of the derived page.

Method Detail

getResult

@Exported
public hudson.model.Result getResult()

Returns:

the Result of for executing the logic to obtaining the Value for this component of the derived page. Inheriting implementations may establish their own convention for how to handle an unsuccessful Value derivation. Some use cases may omit the component, some might invalidate the entire derived page, some might substitute a default or null-indicative value, or some might ignore 'success' entirely.

getValue

@Exported
public Value getValue()

Returns:

the value of the derived component.