gradle/org.gradle.api.problems/ProblemId

ProblemId

Represents a unique identifier for a problem definition.

Problem IDs are defined with a name and with group hierarchy. For example, in the domain of Java compilation problems, the id object for unused variable warnings would be:

ProblemId(name: unused-variable, displayName: Unused Variable, group:
    ProblemGroup(name: Java, displayName: Java, parent:
        ProblemGroup(name: Compilation, displayName: Compilation, parent: null)))

From the name fields a fully qualified name can be inferred: Compilation:Java:unused-variable. Also, the display names are intended for display on some user interface. Consumers of problem reports can build a tree representation of problems:

(Problem view)
Compilation
    Java
        Foo.java#L10: unused variable a
        Foo.java#L20: unused variable b

Since

8.13

Functions

create

open fun create(name: String, displayName: String, group: ProblemGroup): ProblemId

Creates a new problem id.

getDisplayName

abstract fun getDisplayName(): String

A human-readable label describing the problem ID.

getGroup

abstract fun getGroup(): ProblemGroup

The parent group.

getName

abstract fun getName(): String

The name of the problem.

ProblemId

Since

See also

Functions