Class StaticAnalysisLabelProvider
java.lang.Object
io.jenkins.plugins.analysis.core.model.StaticAnalysisLabelProvider
- All Implemented Interfaces:
DescriptionProvider
- Direct Known Subclasses:
IconLabelProvider
,SvgIconLabelProvider
,SymbolIconLabelProvider
A generic label provider for static analysis results. Creates pre-defined labels that are parameterized with a string
placeholder, that will be replaced with the actual name of the static analysis tool. Moreover, such a default label
provider decorates the links and summary boxes with the default icon of the warnings plug-in.
- Author:
- Ullrich Hafner
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interface
Functional interface that maps the age of a build from an integer value to a String value.static class
Computes the age of a build as a hyperlink. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Default icon for all tools.protected static final DescriptionProvider
Provides an empty description. -
Constructor Summary
ConstructorsConstructorDescriptionStaticAnalysisLabelProvider
(String id, String name) Creates a newStaticAnalysisLabelProvider
with the specified ID.StaticAnalysisLabelProvider
(String id, String name, DescriptionProvider descriptionProvider) Creates a newStaticAnalysisLabelProvider
with the specified ID. -
Method Summary
Modifier and TypeMethodDescriptiongetAgeBuilder
(Run<?, ?> owner, String url) Creates aStaticAnalysisLabelProvider.DefaultAgeBuilder
for the specified run and url.getDescription
(edu.hm.hafner.analysis.Issue issue) Returns a detailed description of the specified issue.protected FileNameRenderer
getFileNameRenderer
(Run<?, ?> owner) Creates aFileNameRenderer
for the specified run.j2html.tags.ContainerTag
getFixedIssuesLabel
(int fixedSize) Deprecated.getId()
Returns the ID of the tool.getIssuesModel
(Run<?, ?> build, String url, edu.hm.hafner.analysis.Report report) Returns the model for the issues details table.Returns the absolute URL to the large icon for the tool.Returns the name of the link to the results.getName()
Returns the human-readable name of the tool.j2html.tags.ContainerTag
getNewIssuesLabel
(int newSize) Deprecated.rendering of the summary is now done on the client side with the new modelSummaryModel
j2html.tags.DomContent
getNoIssuesSinceLabel
(int currentBuild, int noIssuesSinceBuild) Deprecated.rendering of the summary is now done on the client side with the new modelSummaryModel
j2html.tags.DomContent
getQualityGateResult
(QualityGateStatus qualityGateStatus) Deprecated.rendering of the summary is now done on the client side with the new modelSummaryModel
j2html.tags.DomContent
getQualityGateResult
(QualityGateStatus qualityGateStatus, boolean hasResetLink) Deprecated.rendering of the summary is now done on the client side with the new modelSummaryModel
Deprecated.usegetLinkName()
j2html.tags.DomContent
getReferenceBuild
(Run<?, ?> referenceBuild) Deprecated.rendering of the summary is now done on the client side with the new modelSummaryModel
Returns the absolute URL to the small icon for the tool.getSourceCodeDescription
(Run<?, ?> build, edu.hm.hafner.analysis.Issue issue) Returns an additional description of the specified issue that will be shown with the source code.j2html.tags.ContainerTag
getTitle
(AnalysisResult result, boolean hasErrors) Deprecated.rendering of the summary is now done on the client side with the new modelSummaryModel
getToolTip
(int numberOfItems) Returns a short description describing the total number of issues.Returns the legend for the trend chart in the project overview.Sets the human-readable name of the tool.toString()
-
Field Details
-
ANALYSIS_SVG_ICON
Default icon for all tools.- See Also:
-
EMPTY_DESCRIPTION
Provides an empty description.
-
-
Constructor Details
-
StaticAnalysisLabelProvider
Creates a newStaticAnalysisLabelProvider
with the specified ID.- Parameters:
id
- the IDname
- the name of the static analysis tool
-
StaticAnalysisLabelProvider
public StaticAnalysisLabelProvider(String id, @CheckForNull String name, DescriptionProvider descriptionProvider) Creates a newStaticAnalysisLabelProvider
with the specified ID.- Parameters:
id
- the IDname
- the name of the static analysis tooldescriptionProvider
- provides additional descriptions for an issue
-
-
Method Details
-
getIssuesModel
public DetailsTableModel getIssuesModel(Run<?, ?> build, String url, edu.hm.hafner.analysis.Report report) Returns the model for the issues details table.- Parameters:
build
- the build of the resultsurl
- the URL of the resultsreport
- the report to show- Returns:
- the table model
-
getAgeBuilder
Creates aStaticAnalysisLabelProvider.DefaultAgeBuilder
for the specified run and url.- Parameters:
owner
- the run to get the age fromurl
- the url to the results- Returns:
- the age builder
-
getFileNameRenderer
Creates aFileNameRenderer
for the specified run.- Parameters:
owner
- the run to get the file names for- Returns:
- the age builder
-
getId
Returns the ID of the tool.- Returns:
- the ID
-
getName
Returns the human-readable name of the tool. If the name has not been set, then the default name is returned.- Returns:
- the name
-
setName
Sets the human-readable name of the tool.- Parameters:
name
- the name of the tool- Returns:
- the name
-
toString
-
getLinkName
Returns the name of the link to the results.- Returns:
- the name of the side panel link
-
getRawLinkName
Deprecated.usegetLinkName()
Returns the name of the link to the results.- Returns:
- the name of the side panel link
-
getTrendName
Returns the legend for the trend chart in the project overview.- Returns:
- the legend of the trend chart
-
getSmallIconUrl
Returns the absolute URL to the small icon for the tool.- Returns:
- absolute URL
-
getLargeIconUrl
Returns the absolute URL to the large icon for the tool.- Returns:
- absolute URL
-
getTitle
Deprecated.rendering of the summary is now done on the client side with the new modelSummaryModel
Returns the title for the small information box in the corresponding build page.- Parameters:
result
- the resulthasErrors
- indicates if an error has been reported- Returns:
- the title div
-
getNewIssuesLabel
Deprecated.rendering of the summary is now done on the client side with the new modelSummaryModel
Returns the HTML label for the link to the new issues of the build.- Parameters:
newSize
- the number of new issues- Returns:
- the legend of the trend chart
-
getFixedIssuesLabel
Deprecated.rendering of the summary is now done on the client side with the new modelSummaryModel
Returns the HTML label for the link to the fixed issues of the build.- Parameters:
fixedSize
- the number of fixed issues- Returns:
- the legend of the trend chart
-
getNoIssuesSinceLabel
@Deprecated public j2html.tags.DomContent getNoIssuesSinceLabel(int currentBuild, int noIssuesSinceBuild) Deprecated.rendering of the summary is now done on the client side with the new modelSummaryModel
Returns the HTML text showing the number of builds since the project has no issues.- Parameters:
currentBuild
- the current build numbernoIssuesSinceBuild
- the build since there are no issues- Returns:
- the legend of the trend chart
-
getQualityGateResult
Deprecated.rendering of the summary is now done on the client side with the new modelSummaryModel
Returns the HTML text showing the result of the quality gate.- Parameters:
qualityGateStatus
- the status of the quality gate- Returns:
- the legend of the trend chart
-
getQualityGateResult
@Deprecated public j2html.tags.DomContent getQualityGateResult(QualityGateStatus qualityGateStatus, boolean hasResetLink) Deprecated.rendering of the summary is now done on the client side with the new modelSummaryModel
Returns the HTML text showing the result of the quality gate.- Parameters:
qualityGateStatus
- the status of the quality gatehasResetLink
- determines whether the reset reference link is shown- Returns:
- the legend of the trend chart
-
getReferenceBuild
Deprecated.rendering of the summary is now done on the client side with the new modelSummaryModel
Returns the HTML text showing a link to the reference build.- Parameters:
referenceBuild
- the reference build- Returns:
- the legend of the trend chart
-
getToolTip
Returns a short description describing the total number of issues.- Parameters:
numberOfItems
- the number of issues to report- Returns:
- the description
-
getDescription
Description copied from interface:DescriptionProvider
Returns a detailed description of the specified issue.- Specified by:
getDescription
in interfaceDescriptionProvider
- Parameters:
issue
- the issue to get the description for- Returns:
- the description
-
getSourceCodeDescription
Returns an additional description of the specified issue that will be shown with the source code.- Parameters:
build
- the current buildissue
- the issue- Returns:
- the additional description
-
SummaryModel