Skip to content

Latest commit

 

History

History
41 lines (33 loc) · 1.71 KB

MIGRATION.md

File metadata and controls

41 lines (33 loc) · 1.71 KB
Raw

MIGRATION

Preamble

2.0.0 release contained a breaking API change which broke binary compatibility. This was attributed to an issue with Java 9 Modules, for which JPMS disallows split packages. The encoding-base16, encoding-base32 and encoding-base64 dependencies were the cause of the issue because their builder classes and functions were located in the same package named io.matthewnelson.encoding.builders. Those classes and functions were subsequently deprecated in release 1.2.3 so consumers could gracefully update before upgrading to 2.0.0 where they have been removed.

For more details, see [#124].

Migration guide for 1.x.x -> 2.0.0

  • Update dependency to version 1.2.3
    • Migration method 1:
      • Use your IDE or editor to search your project for the following 
        import io.matthewnelson.encoding.builders
      • Replace .builders with the new package location (either base16, base32, or base64)
    • Migration method 2:
      • Use the provided ReplaceWith functionality of the @Deprecated notice to update to the new builder class/function package locations.
  • Update dependencies to new maven target: 
    // Bill of Materials
implementation(platform("io.matthewnelson.encoding:bom:2.0.0"))

// New Maven Central target (include version if not using the BOM)
implementation("io.matthewnelson.encoding:base16")
implementation("io.matthewnelson.encoding:base32")
implementation("io.matthewnelson.encoding:base64")

// optionally if you only want the abstractions
implementation("io.matthewnelson.encoding:core")