Package jetbrains.buildServer.serverSide.healthStatus

Class CompositeHealthStatusReportTestUtil.TestReport

java.lang.Object

jetbrains.buildServer.serverSide.healthStatus.HealthStatusReport

jetbrains.buildServer.serverSide.healthStatus.CompositeHealthStatusReportTestUtil.TestReport

All Implemented Interfaces:

ServerExtension, TeamCityExtension

Direct Known Subclasses:

CompositeHealthStatusReportTestUtil.ControlledReport, CompositeHealthStatusReportTestUtil.NoOpReport

Enclosing class:

CompositeHealthStatusReportTestUtil

public abstract static class CompositeHealthStatusReportTestUtil.TestReport
extends HealthStatusReport

Constructor Summary

Constructors

Constructor	Description
TestReport(String type)
TestReport(ItemCategory reportCaterogy)
TestReport(ItemCategory reportCaterogy, String type)

Method Summary

Modifier and Type	Method	Description
boolean	canReportItemsFor(HealthStatusScope scope)	Check whether the report can produce any items accepted by the specified scope.
Collection<ItemCategory>	getCategories()	Problems categories producing by this problem finder.
String	getDisplayName()	User presentable name of the problem finder.
String	getType()

Methods inherited from class jetbrains.buildServer.serverSide.healthStatus.HealthStatusReport

equals, hashCode, report

Methods inherited from class java.lang.Object

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

Constructor Detail

TestReport

public TestReport(ItemCategory reportCaterogy)

TestReport

public TestReport(String type)

TestReport

public TestReport(ItemCategory reportCaterogy,
                  String type)

Method Detail

getDisplayName

@NotNull
public String getDisplayName()

Description copied from class: HealthStatusReport

User presentable name of the problem finder.

Specified by:

getDisplayName in class HealthStatusReport

Returns:

name of the problem finder to show in the user interface.

getType

@NotNull
public String getType()

Specified by:

getType in class HealthStatusReport

Returns:

unique identifier of the problem finder

getCategories

@NotNull
public Collection<ItemCategory> getCategories()

Description copied from class: HealthStatusReport

Problems categories producing by this problem finder. All problems of 'undeclared' categories will be filtered even if they were consumed.

Specified by:

getCategories in class HealthStatusReport

Returns:

Unmodifiable not-empty collection of unique categories producing by this problem finder.

canReportItemsFor

public boolean canReportItemsFor(HealthStatusScope scope)

Description copied from class: HealthStatusReport

Check whether the report can produce any items accepted by the specified scope. HealthStatusReport.report(HealthStatusScope, HealthStatusItemConsumer) will not be called if this method return false. Implementations should not perform any complex calculations, they are expected to quickly analyze HealthStatusScope and return false if it is clear that they can not report any acceptable items. For example, they can return false if they can't produce items with the requested severity (that is accepted by HealthStatusScope.isItemWithSeverityAccepted(ItemSeverity)).

Specified by:

canReportItemsFor in class HealthStatusReport