# ProblemSpec

@Incubating
interface ProblemSpec

Provides options to configure problems.

#### Since

8.6

#### See also

ProblemReporter

## Functions

additionalData
Link copied to clipboard
abstract fun <T : AdditionalData?> additionalData(type: Class<T>, config: Action<in T>): ProblemSpec
Declares additional data attached to the problem.
additionalData
Link copied to clipboard
@Incubating
inline fun <T : AdditionalData> ProblemSpec.additionalData(type: KClass<T>, config: Action<in T>): ProblemSpec

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.problems.ProblemSpec.additionalData.

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
Declares a long description detailing the 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.
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.
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
Declares solutions and advice that contain context-sensitive data, e.g.
stackLocation
Link copied to clipboard
abstract fun stackLocation(): ProblemSpec
Declares that this problem is at the same place where it's reported.
withException
Link copied to clipboard
abstract fun withException(t: Throwable): ProblemSpec
Declares the exception causing this problem.