Package com.atlassian.jira.upgrade

Class UpgradeResult

java.lang.Object

com.atlassian.jira.upgrade.UpgradeResult

public class UpgradeResult
extends Object

Result of the upgrade process

Field Summary

Fields

Modifier and Type	Field	Description
static final UpgradeResult	OK

Constructor Summary

Constructors

Constructor	Description
UpgradeResult()	Creates an UpgradeResult with no errors.
UpgradeResult(String error)	Creates status with only one error message and indexing params set to none.
UpgradeResult(Collection<String> errors)	Creates status with only one error message and indexing params set to none.

Method Summary

Modifier and Type	Method	Description
void	addError(String error)	Add an error message to the result.
Collection<String>	getErrors()	List of errors that occurred during the upgrade
boolean	successful()	Checks whether this upgrade was successful.

Methods inherited from class java.lang.Object

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

Field Details

OK

public static final UpgradeResult OK

Constructor Details

UpgradeResult

public UpgradeResult()

Creates an UpgradeResult with no errors. Errors can be added using addError(String)

UpgradeResult

public UpgradeResult(String error)

Creates status with only one error message and indexing params set to none.

Parameters:

error - the only error message

UpgradeResult

public UpgradeResult(Collection<String> errors)

Creates status with only one error message and indexing params set to none.

Parameters:

errors - a list of errors that occurred during the upgrade

Method Details

successful

public boolean successful()

Checks whether this upgrade was successful.

Returns:

true if upgrade tasks returned no errors

getErrors

public Collection<String> getErrors()

List of errors that occurred during the upgrade

Returns:

list of errors

addError

public void addError(String error)

Add an error message to the result.

Parameters:

error - to add to the result