Package org.openhab.core.tools

Interface Upgrader

All Known Implementing Classes:
ExtractedAddonUpgrader
@NonNullByDefault public interface Upgrader
The Upgrader provides an interface for upgrading openHAB configuration files. Implementing class MUST provide a no-argument constructor.
Author:
Jimmy Tanagra - Initial contribution

  • Method Details

    • getName

      String getName()

    • getDescription

      String getDescription()

    • getTargetVersion

      default @Nullable String getTargetVersion()

    • execute

      boolean execute(@Nullable Path userdataPath, @Nullable Path confPath)
      Executes the upgrade process.
      Parameters:
      userdataPath - the OPENHAB_USERDATA directory for the upgrade, or a custom path given by the user as --userdata argument
      confPath - the OPENHAB_CONF directory for the upgrade, or a custom path given by the user as --conf argument
      Returns:
      true if the upgrade was successful, false otherwise