public abstract class

AbstractUpgradeTask

extends Object
implements UpgradeTask
java.lang.Object
   ↳ com.atlassian.confluence.upgrade.AbstractUpgradeTask
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

A useful base class for UpgradeTasks. Note that this base class has a default implementation of validate which does nothing. This is a common case but if you do need validation be sure to override it.

Summary

[Expand]
Inherited Fields
From interface com.atlassian.confluence.upgrade.UpgradeTask
Public Constructors
AbstractUpgradeTask()
Public Methods
String getBuildNumber()
BuildNumberUpgradeConstraint getConstraint()
Collection<UpgradeError> getErrors()
Return any errors that occur.
String getShortDescription()
A short (
void setBuildNumber(String buildNumber)
void validate()

This is only implemented in this abstract base class for the convenience of the large number of older upgrade tasks.

Protected Methods
void addAllErrors(Collection<UpgradeError> errors)
void addError(UpgradeError error)
void addError(String errorMessage)
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.confluence.upgrade.UpgradeTask

Public Constructors

public AbstractUpgradeTask ()

Public Methods

public String getBuildNumber ()

public BuildNumberUpgradeConstraint getConstraint ()

public Collection<UpgradeError> getErrors ()

Return any errors that occur. Each entry is an UpgradeError.

Returns

public String getShortDescription ()

A short (

public void setBuildNumber (String buildNumber)

public void validate ()

This is only implemented in this abstract base class for the convenience of the large number of older upgrade tasks.

If you are implementing a new UpgradeTask you must give some consideration to implementing validation as well.

Throws
Exception

Protected Methods

protected void addAllErrors (Collection<UpgradeError> errors)

protected void addError (UpgradeError error)

protected void addError (String errorMessage)