com.atlassian.jira.startup

Interface FaultDescription

All Known Subinterfaces:

StartupCheck

All Known Implementing Classes:

EmbeddedDatabaseTypeCheck, FailedStartupCheck, JiraHomeStartupCheck

public interface FaultDescription

Implemented by objects which can describe problems

Since:

7.4

Method Summary

Modifier and Type	Method and Description
static FaultDescription	fromString(String description) Create a FaultDescription containing a String
String	getFaultDescription() Returns the description of the fault.

Method Detail

getFaultDescription

@Nullable
String getFaultDescription()

Returns the description of the fault. This method should return null in the case the check was positive. This message is used to present the user with a message to the console.

Returns:

String containing the fault description

fromString

static FaultDescription fromString(@Nullable
                                   String description)

Create a FaultDescription containing a String

Parameters:

description - the String description

Returns:

a FaultDescription