Package com.atlassian.upgrade

Interface UpgradeTask

All Known Subinterfaces:
DatabaseUpgradeTask
All Known Implementing Classes:
AbstractUpgradeTask
public interface UpgradeTask

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.apache.log4j.Category
    log
    All upgrade tasks should use this log for convenience, unless there's some overriding reason to use a different log

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    doUpgrade()
    Perform the upgrade.
    String
    getBuildNumber()
     
    Collection<UpgradeError>
    getErrors()
    Return any errors that occur.
    String
    getShortDescription()
    A short (<50 chars) description of the upgrade action

  • Field Details

    • log

      static final org.apache.log4j.Category log
      All upgrade tasks should use this log for convenience, unless there's some overriding reason to use a different log

  • Method Details

    • getBuildNumber

      String getBuildNumber()
      Returns:
      The build number that this upgrade is applicable to

    • getShortDescription

      String getShortDescription()
      A short (<50 chars) description of the upgrade action

    • doUpgrade

      void doUpgrade() throws Exception
      Perform the upgrade.
      Throws:
      Exception

    • getErrors

      Collection<UpgradeError> getErrors()
      Return any errors that occur. Each entry is an UpgradeError.