Package org.gradle.api.problems

Class ProblemGroup

java.lang.Object

org.gradle.api.problems.ProblemGroup

@Incubating
@Immutable
public abstract class ProblemGroup
extends Object

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:

• ProblemId

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ProblemGroup()	Constructor.

Method Summary

Modifier and Type	Method	Description
static ProblemGroup	create(String name, String displayName)	Creates a new root problem i.e.
static ProblemGroup	create(String name, String displayName, ProblemGroup parent)	Creates a new problem group.
abstract String	getDisplayName()	Returns a human-readable label describing the group.
abstract String	getName()	The name of the problem group.
abstract ProblemGroup	getParent()	Returns the parent group or null for root groups.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ProblemGroup

protected ProblemGroup()

Constructor.

Since:

8.13

Method Details

getName

public abstract String getName()

The name of the problem group.

Since:

8.8

getDisplayName

public abstract String getDisplayName()

Returns a human-readable label describing the group.

Since:

8.8

getParent

@Nullable
public abstract ProblemGroup getParent()

Returns the parent group or null for root groups.

Since:

8.8

create

public static ProblemGroup create(String name,
 String displayName)

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

public static ProblemGroup create(String name,
 String displayName,
 @Nullable
 ProblemGroup parent)

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 group

parent - the parent group

Returns:

the new group

Since:

8.13