# ProblemSpec

@Incubating
interface ProblemSpec(source)

Provides options to configure problems.

#### Since

8.6

#### See also

ProblemReporter

## Functions

contextualLabel
Link copied to clipboard
abstract fun contextualLabel(contextualLabel: String): ProblemSpec
Declares a short, but context-dependent message for this problem.
details
Link copied to clipboard
abstract fun details(details: String): ProblemSpec
The long description of this problem.
documentedAt
Link copied to clipboard
abstract fun documentedAt(url: String): ProblemSpec
Declares where this problem is documented.
fileLocation
Link copied to clipboard
abstract fun fileLocation(path: String): ProblemSpec
Declares that this problem is in a file.
id
Link copied to clipboard
abstract fun id(name: String, displayName: String): ProblemSpec
abstract fun id(name: String, displayName: String, parent: ProblemGroup): ProblemSpec
Defines simple identification for this problem.
lineInFileLocation
Link copied to clipboard
abstract fun lineInFileLocation(path: String, line: Int): ProblemSpec
Declares that this problem is in a file on a line.
abstract fun lineInFileLocation(path: String, line: Int, column: Int): ProblemSpec
abstract fun lineInFileLocation(path: String, line: Int, column: Int, length: Int): ProblemSpec
Declares that this problem is in a file with on a line at a certain position.
offsetInFileLocation
Link copied to clipboard
abstract fun offsetInFileLocation(path: String, offset: Int, length: Int): ProblemSpec
Declares that this problem is in a file at a certain global position with a given length.
pluginLocation
Link copied to clipboard
abstract fun pluginLocation(pluginId: String): ProblemSpec
Declares that this problem is emitted while applying a plugin.
severity
Link copied to clipboard
abstract fun severity(severity: Severity): ProblemSpec
Declares the severity of the problem.
solution
Link copied to clipboard
abstract fun solution(solution: String): ProblemSpec
A description of how to solve this problem.
stackLocation
Link copied to clipboard
abstract fun stackLocation(): ProblemSpec
Declares that this problem should automatically collect the location information based on the current stack trace.
withException
Link copied to clipboard
abstract fun withException(e: RuntimeException): ProblemSpec
The exception causing this problem.