@ExportedBean(defaultVisibility=2) public class HealthReport extends Object implements Serializable, Comparable<HealthReport>
Modifier and Type | Class and Description |
---|---|
static class |
HealthReport.ConverterImpl
Fix deserialization of older data.
|
Constructor and Description |
---|
HealthReport()
Create a new HealthReport.
|
HealthReport(int score,
org.jvnet.localizer.Localizable description)
Create a new HealthReport.
|
HealthReport(int score,
String description)
Deprecated.
since 2008-10-18.
Use
HealthReport(int, org.jvnet.localizer.Localizable) |
HealthReport(int score,
String iconUrl,
org.jvnet.localizer.Localizable description)
Create a new HealthReport.
|
HealthReport(int score,
String iconUrl,
String description)
Deprecated.
since 2008-10-18.
Use
HealthReport(int, String, org.jvnet.localizer.Localizable) |
Modifier and Type | Method and Description |
---|---|
int |
compareTo(HealthReport o) |
List<HealthReport> |
getAggregatedReports()
Getter for property 'aggregatedReports'.
|
String |
getDescription()
Getter for property 'description'.
|
String |
getIconClassName()
Get health status icon class.
|
String |
getIconUrl()
Getter for property 'iconUrl'.
|
String |
getIconUrl(String size)
Get's the iconUrl relative to the hudson root url, for the correct size.
|
org.jvnet.localizer.Localizable |
getLocalizableDescription()
Getter for property 'localizibleDescription'.
|
int |
getScore()
Getter for property 'score'.
|
boolean |
isAggregateReport()
Getter for property 'aggregateReport'.
|
static HealthReport |
max(HealthReport a,
HealthReport b)
Utility method to find the report with the highest health.
|
static HealthReport |
min(HealthReport a,
HealthReport b)
Utility method to find the report with the lowest health.
|
void |
setDescription(String description)
Setter for property 'description'.
|
void |
setIconUrl(String iconUrl)
Setter for property 'iconUrl'.
|
void |
setLocalizibleDescription(org.jvnet.localizer.Localizable localizibleDescription)
Setter for property 'localizibleDescription'.
|
void |
setScore(int score)
Setter for property 'score'.
|
@Deprecated public HealthReport(int score, String iconUrl, String description)
HealthReport(int, String, org.jvnet.localizer.Localizable)
score
- The percentage health score (from 0 to 100 inclusive).iconUrl
- The path to the icon corresponding to this Action
's health or null
to
display the default icon corresponding to the current health score.
If the path begins with a '/' then it will be the absolute path, otherwise the image is
assumed to be in one of /images/16x16/
, /images/24x24/
or
/images/32x32/
depending on the icon size selected by the user.
When calculating the url to display for absolute paths, the getIconUrl(String) method
will replace /32x32/ in the path with the appropriate size.
description
- The health icon's tool-tip.public HealthReport(int score, String iconUrl, org.jvnet.localizer.Localizable description)
score
- The percentage health score (from 0 to 100 inclusive).iconUrl
- The path to the icon corresponding to this Action
's health or null
to
display the default icon corresponding to the current health score.
If the path begins with a '/' then it will be the absolute path, otherwise the image is
assumed to be in one of /images/16x16/
, /images/24x24/
or
/images/32x32/
depending on the icon size selected by the user.
When calculating the url to display for absolute paths, the getIconUrl(String) method
will replace /32x32/ in the path with the appropriate size.
description
- The health icon's tool-tip.@Deprecated public HealthReport(int score, String description)
HealthReport(int, org.jvnet.localizer.Localizable)
score
- The percentage health score (from 0 to 100 inclusive).description
- The health icon's tool-tip.public HealthReport(int score, org.jvnet.localizer.Localizable description)
score
- The percentage health score (from 0 to 100 inclusive).description
- The health icon's tool-tip.public HealthReport()
@Exported public int getScore()
public void setScore(int score)
score
- Value to set for property 'score'.@Exported public String getIconUrl()
@Exported public String getIconClassName()
public String getIconUrl(String size)
size
- The size, e.g. 32x32, 24x24 or 16x16.public void setIconUrl(String iconUrl)
iconUrl
- Value to set for property 'iconUrl'.@Exported public String getDescription()
public void setDescription(String description)
description
- Value to set for property 'description'.public org.jvnet.localizer.Localizable getLocalizableDescription()
public void setLocalizibleDescription(org.jvnet.localizer.Localizable localizibleDescription)
localizibleDescription
- Value to set for property 'localizibleDescription'.public List<HealthReport> getAggregatedReports()
public boolean isAggregateReport()
public int compareTo(HealthReport o)
compareTo
in interface Comparable<HealthReport>
public static HealthReport min(HealthReport a, HealthReport b)
public static HealthReport max(HealthReport a, HealthReport b)
Copyright © 2004–2019. All rights reserved.