Interface Problems

@Incubating @ServiceScope(org.gradle.internal.service.scopes.Scope.BuildTree.class) public interface Problems
Problems API service.

The main purpose of this API is to allow clients to create, configure, and report problems in a centralized way.

Reported problems are exposed via build operation progress events, which then are converted to Tooling API progress events.

Clients should expect that in future Gradle versions the reported problems will appear in console messages, reports, etc.

Since:
8.4

  • Method Details

    • getReporter

      ProblemReporter getReporter()
      Return a problem reporter associated with a plugin.
      Returns:
      The problem reporter.
      Since:
      8.11

    • getGroups

      ProblemGroups getGroups()
      Returns the problem groups.

      Problem ids should be created from these groups, for example getGroups().getCompilation().getJava().problemId("Unused import"). The groups and the ids created from them are stable values; create them once and reuse them at every report site.

      Returns:
      The predefined problem groups.
      Since:
      9.9.0