@Incubating public interface ProblemSpec
ProblemReporter
Modifier and Type | Method | Description |
---|---|---|
ProblemSpec |
contextualLabel(java.lang.String contextualLabel) |
Declares a short, but context-dependent message for this problem.
|
ProblemSpec |
details(java.lang.String details) |
The long description of this problem.
|
ProblemSpec |
documentedAt(java.lang.String url) |
Declares where this problem is documented.
|
ProblemSpec |
fileLocation(java.lang.String path) |
Declares that this problem is in a file.
|
ProblemSpec |
id(java.lang.String name,
java.lang.String displayName) |
Defines simple identification for this problem.
|
ProblemSpec |
id(java.lang.String name,
java.lang.String displayName,
ProblemGroup parent) |
Defines simple identification for this problem.
|
ProblemSpec |
lineInFileLocation(java.lang.String path,
int line) |
Declares that this problem is in a file on a line.
|
ProblemSpec |
lineInFileLocation(java.lang.String path,
int line,
int column) |
Declares that this problem is in a file with on a line at a certain position.
|
ProblemSpec |
lineInFileLocation(java.lang.String path,
int line,
int column,
int length) |
Declares that this problem is in a file with on a line at a certain position.
|
ProblemSpec |
offsetInFileLocation(java.lang.String path,
int offset,
int length) |
Declares that this problem is in a file at a certain global position with a given length.
|
ProblemSpec |
pluginLocation(java.lang.String pluginId) |
Declares that this problem is emitted while applying a plugin.
|
ProblemSpec |
severity(Severity severity) |
Declares the severity of the problem.
|
ProblemSpec |
solution(java.lang.String solution) |
A description of how to solve this problem.
|
ProblemSpec |
stackLocation() |
Declares that this problem should automatically collect the location information based on the current stack trace.
|
ProblemSpec |
withException(java.lang.RuntimeException e) |
The exception causing this problem.
|
ProblemSpec id(java.lang.String name, java.lang.String displayName)
It is a mandatory property to configure when emitting a problem with ProblemReporter
..
Calling this method will set the reported problem group to SharedProblemGroup.generic()
name
- the name of the problem. As a convention kebab-case-formatting should be used.displayName
- a human-readable representation of the problem, free of any contextual information.ProblemSpec id(java.lang.String name, java.lang.String displayName, ProblemGroup parent)
It is a mandatory property to configure when emitting a problem with ProblemReporter
.
name
- the name of the problem. As a convention kebab-case-formatting should be used.displayName
- a human-readable representation of the problem, free of any contextual information.parent
- the container problem group.ProblemSpec contextualLabel(java.lang.String contextualLabel)
contextualLabel
- the short messageProblemSpec documentedAt(java.lang.String url)
ProblemSpec fileLocation(java.lang.String path)
path
- the file locationProblemSpec lineInFileLocation(java.lang.String path, int line)
path
- the file locationline
- the one-indexed line numberProblemSpec lineInFileLocation(java.lang.String path, int line, int column)
path
- the file locationline
- the one-indexed line numbercolumn
- the one-indexed columnProblemSpec lineInFileLocation(java.lang.String path, int line, int column, int length)
path
- the file locationline
- the one-indexed line numbercolumn
- the one-indexed columnlength
- the length of the textProblemSpec offsetInFileLocation(java.lang.String path, int offset, int length)
path
- the file locationoffset
- the zero-indexed global offset from the beginning of the filelength
- the length of the textProblemSpec pluginLocation(java.lang.String pluginId)
pluginId
- the ID of the applied pluginProblemSpec stackLocation()
ProblemSpec details(java.lang.String details)
details
- the detailsProblemSpec solution(java.lang.String solution)
solution
- the solution.ProblemSpec withException(java.lang.RuntimeException e)
e
- the exception.ProblemSpec severity(Severity severity)
severity
- the severity