Nutrient 10 (PSPDFKit 2025.1) rebrand migration guide
This guide outlines the changes to Nutrient Android SDK 10, which is the next version up from 2024.9 and equivalent to version 2025.1 in our previous versioning scheme.
Versioning scheme
This version marks the start of the new Maven package name and changes the versioning scheme to the more standard major.minor.patch
, which we previously used. We start the versioning at major version 10
, skipping 9
, which represents our 2024.*
versions we released over the last year.
Maven
Package
Our library dependency has been renamed. This means you need to update your Gradle files’ dependencies
list to reflect this:
dependencies { ... - implementation("com.pspdfkit:pspdfkit:2024.9.0") + implementation("io.nutrient:nutrient:10.0.0")
dependencies { ... - implementation('com.pspdfkit:pspdfkit:2024.9.0') + implementation('io.nutrient:nutrient:10.0.0')
Repository URL
The Maven URL has also been updated to https://my.nutrient.io/maven
, although the legacy URL will still work for now:
dependencyResolutionManagement { repositories { ... - maven(url = "https://customers.pspdfkit.com/maven/") + maven(url = "https://my.nutrient.io/maven/")
dependencyResolutionManagement { repositories { ... - maven { url 'https://customers.pspdfkit.com/maven/' } + maven { url 'https://my.nutrient.io/maven/' }
Artefact URL
The actual location of the files has changed. It used to be:
https://my.nutrient.io/maven/com/pspdfkit/pspdfkit/<version>/<file>
Now, it’s:
https://my.nutrient.io/maven/io/nutrient/nutrient/<version>/<file>
For version 10 to access the .aar
library file, use:
https://my.nutrient.io/maven/io/nutrient/nutrient/10.0.0/nutrient-10.0.0.aar
Legacy
All releases before 10.0 use the original URL and dependency naming scheme.
Rebranding API changes
The rebranding API changes in this version are by no means exhaustive; only a few of the key classes have been renamed. The majority of API is the same, and all packages remain inside the
com.pspdfkit.\*
namespace.
PSPDFKit > Nutrient
-
The
PSPDFKit
object class has been deprecated in favor ofNutrient
. The public methods are identical and can be swapped out one-to-one.
Exceptions (breaking changes)
-
PSPDFKitException
renamed toNutrientException
-
PSPDFKitInitializationFailedException
renamed toNutrientInitializationFailedException
-
InvalidPSPDFKitLicenseException
renamed toInvalidNutrientLicenseException
-
PSPDFKitNotInitializedException
renamed toNutrientNotInitializedException