Class PullRequestMonitoringPortlet
- java.lang.Object
-
- io.jenkins.plugins.monitoring.MonitorPortlet
-
- io.jenkins.plugins.analysis.core.portlets.PullRequestMonitoringPortlet
-
public class PullRequestMonitoringPortlet extends io.jenkins.plugins.monitoring.MonitorPortlet
A portlet that can be used for the pull-request-monitoring dashboard. It renders an interactive sunburst diagram for eachResultAction
, which is registered at the current usersRun
.- Author:
- Simon Symhoven
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PullRequestMonitoringPortlet.PortletFactory
The factory for thePullRequestMonitoringPortlet
.
-
Constructor Summary
Constructors Constructor Description PullRequestMonitoringPortlet(ResultAction action)
Creates a newPullRequestMonitoringPortlet
.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Optional<String>
getDetailViewUrl()
Optional<String>
getIconUrl()
String
getId()
String
getNoNewWarningsModel()
Get the json data for the simplified sunburst diagram (used by jelly view).int
getPreferredHeight()
int
getPreferredWidth()
String
getQualityGateResultClass()
Get the icon class of the quality gate.String
getQualityGateResultDescription()
Get the human readable description of quality gate.String
getQualityGateResultIconUrl()
Deprecated.replaced bygetQualityGateResultClass()
String
getTitle()
String
getWarningsModel()
Get the json data for the hierarchical sunburst diagram (used by jelly view).boolean
hasNoNewWarnings()
Check ifAnalysisResult
issues have no new warnings.boolean
hasQualityGate()
Check if action has a quality gate.boolean
isDefault()
boolean
isEmpty()
Check ifAnalysisResult
issues are empty.
-
-
-
Constructor Detail
-
PullRequestMonitoringPortlet
public PullRequestMonitoringPortlet(ResultAction action)
Creates a newPullRequestMonitoringPortlet
.- Parameters:
action
- the correspondingResultAction
.
-
-
Method Detail
-
getTitle
public String getTitle()
- Specified by:
getTitle
in classio.jenkins.plugins.monitoring.MonitorPortlet
-
getId
@JavaScriptMethod public String getId()
- Specified by:
getId
in classio.jenkins.plugins.monitoring.MonitorPortlet
-
isDefault
public boolean isDefault()
- Overrides:
isDefault
in classio.jenkins.plugins.monitoring.MonitorPortlet
-
getPreferredWidth
public int getPreferredWidth()
- Specified by:
getPreferredWidth
in classio.jenkins.plugins.monitoring.MonitorPortlet
-
getPreferredHeight
public int getPreferredHeight()
- Specified by:
getPreferredHeight
in classio.jenkins.plugins.monitoring.MonitorPortlet
-
getIconUrl
public Optional<String> getIconUrl()
- Overrides:
getIconUrl
in classio.jenkins.plugins.monitoring.MonitorPortlet
-
getDetailViewUrl
public Optional<String> getDetailViewUrl()
- Overrides:
getDetailViewUrl
in classio.jenkins.plugins.monitoring.MonitorPortlet
-
getWarningsModel
public String getWarningsModel()
Get the json data for the hierarchical sunburst diagram (used by jelly view).- Returns:
- the data as json string.
-
getNoNewWarningsModel
public String getNoNewWarningsModel()
Get the json data for the simplified sunburst diagram (used by jelly view).- Returns:
- the data as json string.
-
isEmpty
public boolean isEmpty()
Check ifAnalysisResult
issues are empty.- Returns:
- true if
AnalysisResult
issues are empty, else false.
-
hasNoNewWarnings
public boolean hasNoNewWarnings()
Check ifAnalysisResult
issues have no new warnings.- Returns:
- true if
AnalysisResult
issues have now new warnings.
-
hasQualityGate
public boolean hasQualityGate()
Check if action has a quality gate.- Returns:
- true if action has a quality gate, else false.
-
getQualityGateResultIconUrl
@Deprecated public String getQualityGateResultIconUrl()
Deprecated.replaced bygetQualityGateResultClass()
Get the icon of the quality gate.- Returns:
- the image url of the icon.
-
getQualityGateResultClass
public String getQualityGateResultClass()
Get the icon class of the quality gate.- Returns:
- the image class of the Jenkins status icon.
-
getQualityGateResultDescription
public String getQualityGateResultDescription()
Get the human readable description of quality gate.- Returns:
- the description.
-
-