ReportableProblem
@Incubating public interface Problem
Modifier and Type | Method | Description |
---|---|---|
java.util.Map<java.lang.String,java.lang.String> |
getAdditionalData() |
Additional Data about the problem.
|
java.lang.String |
getDetails() |
A long description detailing the problem.
|
DocLink |
getDocumentationLink() |
A link to the documentation for this problem.
|
java.lang.Throwable |
getException() |
The exception that caused the problem.
|
java.lang.String |
getLabel() |
The label of the problem.
|
java.util.List<ProblemLocation> |
getLocations() |
Return the location data associated available for this problem.
|
ProblemCategory |
getProblemCategory() |
Returns the problem category.
|
Severity |
getSeverity() |
Problem severity.
|
java.util.List<java.lang.String> |
getSolutions() |
A list of possible solutions the user can try to fix the problem.
|
ProblemCategory getProblemCategory()
java.lang.String getLabel()
Labels should be short and concise, so they fit approximately in a single line.
@Nullable java.lang.String getDetails()
Details can elaborate on the problem, and provide more information about the problem.
They can be multiple lines long, but should not detail solutions; for that, use getSolutions()
.
Severity getSeverity()
The severity of a problem is a hint to the user about how important the problem is. ERROR will fail the build, WARNING will not.
java.util.List<ProblemLocation> getLocations()
@Nullable DocLink getDocumentationLink()
java.util.List<java.lang.String> getSolutions()
@Nullable java.lang.Throwable getException()
java.util.Map<java.lang.String,java.lang.String> getAdditionalData()