Package org.craftercms.commons.upgrade

Interface UpgradeManager<T>

Type Parameters:
T - The target type supported
All Known Implementing Classes:
AbstractUpgradeManager
public interface UpgradeManager<T>
Manages the current version and applies the required upgrades
Since:
3.1.5
Author:
joseross

  • Method Summary

    Modifier and Type
    Method
    Description
    List<T>
    getTargets()
    Returns all targets to be upgraded
    void
    upgrade()
    Executes all required upgrades for the system
    void
    upgrade(T target)
    Executes all required upgrades for the given target

  • Method Details

    • upgrade

      void upgrade() throws UpgradeException
      Executes all required upgrades for the system
      Throws:
      UpgradeException - if any of the upgrades fails

    • upgrade

      void upgrade(T target) throws UpgradeException
      Executes all required upgrades for the given target
      Parameters:
      target - the target
      Throws:
      UpgradeException - if any of the upgrades fails

    • getTargets

      List<T> getTargets() throws UpgradeException
      Returns all targets to be upgraded
      Returns:
      the list of targets
      Throws:
      UpgradeException - if there is any error finding the targets