Package org.gradle.api.problems
Class ProblemGroup
java.lang.Object
org.gradle.api.problems.ProblemGroup
Represents a group of problems.
Groups are organized in hierarchy where the parent group should represent the more broad problem group.
Two problem groups are considered equal if their getName() and their parents are equal.
- Since:
- 8.8
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic ProblemGroupCreates a new root problem i.e.static ProblemGroupcreate(String name, String displayName, ProblemGroup parent) Creates a new problem group.abstract StringReturns a human-readable label describing the group.abstract StringgetName()The name of the problem group.abstract ProblemGroupReturns the parent group ornullfor root groups.
-
Constructor Details
-
ProblemGroup
protected ProblemGroup()Constructor.- Since:
- 8.13
-
-
Method Details
-
getName
The name of the problem group.- Since:
- 8.8
-
getDisplayName
Returns a human-readable label describing the group.- Since:
- 8.8
-
getParent
Returns the parent group ornullfor root groups.- Since:
- 8.8
-
create
Creates a new root problem i.e. a group with no parent.- Parameters:
name- the name of the group. The convention is to use kebab-case (ie lower case with hyphens).displayName- the user-friendly display name of the group- Returns:
- the new group
- Since:
- 8.13
-
create
Creates a new problem group.- Parameters:
name- the name of the group. The convention is to use kebab-case (ie lower case with hyphens).displayName- the user-friendly display name of the groupparent- the parent group- Returns:
- the new group
- Since:
- 8.13
-