Package com.atlassian.confluence.internal.health

Class HealthCheckResult

java.lang.Object

com.atlassian.confluence.internal.health.HealthCheckResult

@ParametersAreNonnullByDefault
public class HealthCheckResult
extends Object

The result of a HealthCheck.

Since:

6.6.0

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HealthCheckResult(HealthCheck healthCheck, com.atlassian.johnson.event.Event event, @Nullable URL kbUrl, String cause, String logMessage)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)
static List<HealthCheckResult>	fail(HealthCheck healthCheck, com.atlassian.johnson.event.Event event, @Nullable URL kbUrl, String cause, String logMessage)	Create a 'failed' result containing the given parameters.
@NonNull String	getCause()	Returns a human-readable description of this result, with a value that is allowed to be sent via analytics.
@NonNull com.atlassian.johnson.event.Event	getEvent()	Returns the Johnson event to be raised as a result of this result.
@NonNull HealthCheck	getHealthCheck()	Returns the check that gave rise to this result.
@NonNull Optional<URL>	getKbUrl()	Returns the URL of the Atlassian Knowledgebase article that helps the user respond to this result.
@NonNull String	getLogMessage()	Returns the log equivalent of the message shown in the UI for this result
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

HealthCheckResult

protected HealthCheckResult(HealthCheck healthCheck,
                            com.atlassian.johnson.event.Event event,
                            @Nullable URL kbUrl,
                            String cause,
                            String logMessage)

Method Detail

fail

public static List<HealthCheckResult> fail(HealthCheck healthCheck,
                                           com.atlassian.johnson.event.Event event,
                                           @Nullable URL kbUrl,
                                           String cause,
                                           String logMessage)

Create a 'failed' result containing the given parameters.

getHealthCheck

public @NonNull HealthCheck getHealthCheck()

Returns the check that gave rise to this result.

Returns:

see above

getEvent

public @NonNull com.atlassian.johnson.event.Event getEvent()

Returns the Johnson event to be raised as a result of this result.

Returns:

see above

getKbUrl

public @NonNull Optional<URL> getKbUrl()

Returns the URL of the Atlassian Knowledgebase article that helps the user respond to this result.

Returns:

see above

getCause

public @NonNull String getCause()

Returns a human-readable description of this result, with a value that is allowed to be sent via analytics.

Returns:

see above

getLogMessage

public @NonNull String getLogMessage()

Returns the log equivalent of the message shown in the UI for this result

Returns:

see above

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object