ProblemSpec

Problem instance builder that is not capable of creating a new instances. An example of how to use the builder:


 <problemReporter>.report(configurator -> configurator
         .label("test problem")
         .category("category", "subcategory")
         .severity(Severity.ERROR)
         .details("this is a test")
 

Functions

Link copied to clipboard
abstract fun additionalData(key: String, value: Any): ProblemSpec
Specifies arbitrary data associated with this problem.
Link copied to clipboard
abstract fun category(category: String, details: Array<String>): ProblemSpec
Declares the problem category.
Link copied to clipboard
abstract fun details(details: String): ProblemSpec
The long description of this problem.
Link copied to clipboard
abstract fun documentedAt(url: String): ProblemSpec
abstract fun documentedAt(doc: DocLink): ProblemSpec
Declares the documentation for this problem.
Link copied to clipboard
abstract fun fileLocation(path: String, @Nullable line: Integer, @Nullable column: Integer, @Nullable length: Integer): ProblemSpec
Declares that this problem is in a file with optional position and length.
Link copied to clipboard
abstract fun label(label: String, args: Array<Any>): ProblemSpec
Declares a short message for this problem.
Link copied to clipboard
abstract fun pluginLocation(pluginId: String): ProblemSpec
Declares that this problem is emitted while applying a plugin.
Link copied to clipboard
abstract fun severity(severity: Severity): ProblemSpec
Declares the severity of the problem.
Link copied to clipboard
abstract fun solution(solution: String): ProblemSpec
The description of how to solve this problem.
Link copied to clipboard
abstract fun stackLocation(): ProblemSpec
Declares that this problem should automatically collect the location information based on the current stack trace.
Link copied to clipboard
The exception causing this problem.