Interface UpgradeHandler

All Known Implementing Classes:
UpgradeHandler_V10, UpgradeHandler_V11, UpgradeHandler_V12, UpgradeHandler_V13, UpgradeHandler_V14
public sealed interface UpgradeHandler permits UpgradeHandler_V10, UpgradeHandler_V11, UpgradeHandler_V12, UpgradeHandler_V13, UpgradeHandler_V14
A step of the project upgrade that brings the XML and the model from the previous project version to the version it reports in getVersion(). The set of handlers is closed: every handler is a permitted implementation of this interface.
Since:
4.1

  • Field Details

    • CURRENT_VERSION

      static final String CURRENT_VERSION
      Project version written by this version of Cayenne.
      Since:
      5.0
      See Also:

    • MIN_SUPPORTED_VERSION

      static final String MIN_SUPPORTED_VERSION
      The oldest project version that can be upgraded to CURRENT_VERSION. Older projects must first be upgraded with an older CayenneModeler.
      Since:
      5.0
      See Also:

    • UNKNOWN_VERSION

      static final String UNKNOWN_VERSION
      Version reported for projects that whose version can not be determined.
      Since:
      5.0
      See Also:

  • Method Details

    • all

      static List<UpgradeHandler> all()
      Creates an instance of every permitted handler, ordered from the oldest to the current version. Must be kept in sync with the "permits" clause.
      Since:
      5.0

    • getVersion

      String getVersion()

    • upgradeProjectDOM

      void upgradeProjectDOM(UpgradeContext context)
      Since:
      5.0

    • upgradeDataMapDOM

      void upgradeDataMapDOM(UpgradeContext context)
      Since:
      5.0