@Incubating public interface ProblemCategory
Problem
that helps group related problems together.
A category defines the following hierarchical elements to distinguish instances:
The namespace provides separation for identical problems emitted from different components.
Problems emitted from Gradle core will use the org.gradle
namespace.
Third party plugins are expected to use their plugin id for namespace.
Problems emitted from build scripts should use the buildscript
namespace.
A category should contain the most broad term describing the problem.
A few examples are: compilation
, deprecation
, task-validation
.
The problem category can be refined with an optional hierarchy of subcategories.
For example, a problem covering a java compilation warning can be denoted with the following subcategories: [java, unused-variable]
.
The categorization depends on the domain and don't have any constraints. Clients (i.e. IDEs) receiving problems should use the category information for properly group and sort the received instances.
Modifier and Type | Method | Description |
---|---|---|
java.lang.String |
getCategory() |
The main category.
|
java.lang.String |
getNamespace() |
The namespace.
|
java.util.List<java.lang.String> |
getSubCategories() |
The optional subcategories.
|
java.lang.String getNamespace()
java.lang.String getCategory()
java.util.List<java.lang.String> getSubCategories()