Package jetbrains.buildServer.serverSide.healthStatus

Class ItemCategory

java.lang.Object

jetbrains.buildServer.serverSide.healthStatus.ItemCategory

Direct Known Subclasses:

SuggestionCategory

public class ItemCategory
extends Object

Represents type of health status problems.

Since:

8.0 author: Evgeniy.Koshkin

Field Summary

Fields

Modifier and Type	Field	Description
static Comparator<HealthStatusItem>	DEFAULT_COMPARATOR	Comparator that is used for the category if no explicit one was specified.

Constructor Summary

Constructors

Constructor	Description
ItemCategory(String categoryId, String categoryName, ItemSeverity severity)	Creates new inspection results category.
ItemCategory(String categoryId, String categoryName, ItemSeverity severity, String description, String helpUrl)	Creates new inspection results category.
ItemCategory(String categoryId, String categoryName, ItemSeverity severity, String description, String helpUrl, Comparator<HealthStatusItem> itemsComparator)	Creates new inspection results category

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getDescription()	Detailed description of of the type of the problem.
String	getHelpUrl()	Link to on-line help for this problem
String	getId()
Comparator<HealthStatusItem>	getItemsComparator()	Order the items in the category.
String	getName()	Brief name of the type of the problem.
ItemSeverity	getSeverity()	Default severity for problems of this type.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_COMPARATOR

public static final Comparator<HealthStatusItem> DEFAULT_COMPARATOR

Comparator that is used for the category if no explicit one was specified. Compares items by severity.

Constructor Detail

ItemCategory

public ItemCategory(@NotNull
                    String categoryId,
                    @NotNull
                    String categoryName,
                    @NotNull
                    ItemSeverity severity)

Creates new inspection results category.

Parameters:

categoryId - Id for this category. Expected to be unique between categories owned by particular report.

categoryName - brief name of the type of the problem

severity - severity of the items of this category

ItemCategory

public ItemCategory(@NotNull
                    String categoryId,
                    @NotNull
                    String categoryName,
                    @NotNull
                    ItemSeverity severity,
                    @Nullable
                    String description,
                    @Nullable
                    String helpUrl)

Creates new inspection results category.

Parameters:

categoryId - Id for this category. Expected to be unique between categories owned by particular report.

categoryName - brief Name of the type of the problem

severity - severity of the items of this category

description - detailed description of of the type of the problem

helpUrl - link to on-line help for this problem

ItemCategory

public ItemCategory(@NotNull
                    String categoryId,
                    @NotNull
                    String categoryName,
                    @NotNull
                    ItemSeverity severity,
                    @Nullable
                    String description,
                    @Nullable
                    String helpUrl,
                    @NotNull
                    Comparator<HealthStatusItem> itemsComparator)

Creates new inspection results category

Parameters:

categoryId - Id for this category. Expected to be unique between categories owned by particular report.

categoryName - brief Name of the type of the problem

severity - severity of the items of this category

description - detailed description of of the type of the problem

helpUrl - link to on-line help for this problem

itemsComparator - comparator providing order of items in the category. More important items are expected to be first.

Since:

10.0

Method Detail

getId

@NotNull
public String getId()

getName

@NotNull
public String getName()

Brief name of the type of the problem.

getSeverity

@NotNull
public ItemSeverity getSeverity()

Default severity for problems of this type.

getDescription

@Nullable
public String getDescription()

Detailed description of of the type of the problem.

getHelpUrl

@Nullable
public String getHelpUrl()

Link to on-line help for this problem

getItemsComparator

@NotNull
public Comparator<HealthStatusItem> getItemsComparator()

Order the items in the category.

Since:

10.0

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object