Package org.craftercms.commons.upgrade

Interface UpgradeOperation<T>

Type Parameters:
T - The target type supported
All Known Implementing Classes:
AbstractUpgradeOperation, UpdateVersionUpgradeOperation
public interface UpgradeOperation<T>
Defines the basic operations for a single upgrade
Since:
3.1.5
Author:
joseross

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    execute(UpgradeContext<T> context)
    Performs a single upgrade operation.
    void
    init(String currentVersion, String nextVersion, org.apache.commons.configuration2.HierarchicalConfiguration<?> config)
    Initializes the instance with the given configuration

  • Method Details

    • init

      void init(String currentVersion, String nextVersion, org.apache.commons.configuration2.HierarchicalConfiguration<?> config) throws ConfigurationException
      Initializes the instance with the given configuration
      Parameters:
      currentVersion - the current version
      nextVersion - the next version
      config - the operation configuration
      Throws:
      ConfigurationException

    • execute

      void execute(UpgradeContext<T> context) throws UpgradeException
      Performs a single upgrade operation.
      Parameters:
      context - the upgrade context
      Throws:
      UpgradeException - if there is any error performing the upgrade