Migrate to Java 21

org.openrewrite.java.migrate.UpgradeToJava21

This recipe will apply changes commonly needed when migrating to Java 21. This recipe will also replace deprecated API with equivalents when there is a clear migration strategy. Build files will also be updated to use Java 21 as the target/source and plugins will be also be upgraded to versions that are compatible with Java 21.

Tags

• java21

Recipe source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite.recipe

• artifactId: rewrite-migrate-java

• version: 2.12.0

This recipe is composed of more than one recipe. If you want to customize the set of recipes this is composed of, you can find and copy the GitHub source for the recipe from the link above.

Usage

This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-migrate-java:2.12.0 in your build file or by running a shell command (in which case no build changes are needed):

Gradle

1. Add the following to your build.gradle file:

build.gradle

plugins {
    id("org.openrewrite.rewrite") version("6.12.0")
}

rewrite {
    activeRecipe("org.openrewrite.java.migrate.UpgradeToJava21")
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-migrate-java:2.12.0")
}

2. Run gradle rewriteRun to run the recipe.

Gradle init script

1. Create a file named init.gradle in the root of your project.

init.gradle

initscript {
    repositories {
        maven { url "https://plugins.gradle.org/m2" }
    }
    dependencies { classpath("org.openrewrite:plugin:6.12.0") }
}
rootProject {
    plugins.apply(org.openrewrite.gradle.RewritePlugin)
    dependencies {
        rewrite("org.openrewrite.recipe:rewrite-migrate-java:2.12.0")
    }
    rewrite {
        activeRecipe("org.openrewrite.java.migrate.UpgradeToJava21")
    }
    afterEvaluate {
        if (repositories.isEmpty()) {
            repositories {
                mavenCentral()
            }
        }
    }
}

2. Run gradle --init-script init.gradle rewriteRun to run the recipe.

Maven POM

1. Add the following to your pom.xml file:

pom.xml

<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.29.0</version>
        <configuration>
          <activeRecipes>
            <recipe>org.openrewrite.java.migrate.UpgradeToJava21</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-migrate-java</artifactId>
            <version>2.12.0</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>

2. Run mvn rewrite:run to run the recipe.

Maven Command Line

shell

mvn -U org.openrewrite.maven:rewrite-maven-plugin:run -Drewrite.recipeArtifactCoordinates=org.openrewrite.recipe:rewrite-migrate-java:RELEASE -Drewrite.activeRecipes=org.openrewrite.java.migrate.UpgradeToJava21

Moderne CLI

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell

mod run . --recipe UpgradeToJava21

Definition

Recipe List

• Migrate to Java 17

• Change Maven Java version property values to 21

• Remove illegal semicolons

• Replace Thread.resume(), Thread.stop(), and Thread.suspend() with throw new UnsupportedOperationException()

• URLConstructorsToURI Refaster recipes

• Adopt SequencedCollection

• Prefer Locale.of(..) over new Locale(..)

• Replace deprecated Runtime#exec() methods

• Upgrade actions/setup-java java-version

• Update Gradle wrapper

  • version: 8.5

  • addIfMissing: false

• Upgrade Maven plugin version

  • groupId: org.jacoco

  • artifactId: jacoco-maven-plugin

  • newVersion: 0.8.+

• Upgrade Maven plugin version

  • groupId: com.sonatype.clm

  • artifactId: clm-maven-plugin

  • newVersion: 2.47.8-01

• Upgrade Gradle or Maven dependency versions

  • groupId: com.google.guava

  • artifactId: guava

  • newVersion: 29.0

  • versionPattern: -jre

• Upgrade Gradle or Maven dependency versions

  • groupId: net.bytebuddy

  • artifactId: byte-buddy

  • newVersion: 1.14.11

• Upgrade Gradle or Maven dependency versions

  • groupId: org.modelmapper

  • artifactId: modelmapper

  • newVersion: 3.2.x

Yaml Recipe List

---
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.UpgradeToJava21
displayName: Migrate to Java 21
description: This recipe will apply changes commonly needed when migrating to Java 21. This recipe will also replace deprecated API with equivalents when there is a clear migration strategy. Build files will also be updated to use Java 21 as the target/source and plugins will be also be upgraded to versions that are compatible with Java 21.

tags:
  - java21
recipeList:
  - org.openrewrite.java.migrate.UpgradeToJava17
  - org.openrewrite.java.migrate.JavaVersion21
  - org.openrewrite.java.migrate.RemoveIllegalSemicolons
  - org.openrewrite.java.migrate.lang.ThreadStopUnsupported
  - org.openrewrite.java.migrate.net.URLConstructorsToURIRecipes
  - org.openrewrite.java.migrate.util.SequencedCollection
  - org.openrewrite.java.migrate.util.UseLocaleOf
  - org.openrewrite.staticanalysis.ReplaceDeprecatedRuntimeExecMethods
  - org.openrewrite.github.SetupJavaUpgradeJavaVersion:
  - org.openrewrite.gradle.UpdateGradleWrapper:
      version: 8.5
      addIfMissing: false
  - org.openrewrite.maven.UpgradePluginVersion:
      groupId: org.jacoco
      artifactId: jacoco-maven-plugin
      newVersion: 0.8.+
  - org.openrewrite.maven.UpgradePluginVersion:
      groupId: com.sonatype.clm
      artifactId: clm-maven-plugin
      newVersion: 2.47.8-01
  - org.openrewrite.java.dependencies.UpgradeDependencyVersion:
      groupId: com.google.guava
      artifactId: guava
      newVersion: 29.0
      versionPattern: -jre
  - org.openrewrite.java.dependencies.UpgradeDependencyVersion:
      groupId: net.bytebuddy
      artifactId: byte-buddy
      newVersion: 1.14.11
  - org.openrewrite.java.dependencies.UpgradeDependencyVersion:
      groupId: org.modelmapper
      artifactId: modelmapper
      newVersion: 3.2.x

See how this recipe works across multiple open-source repositories

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Contributors

Chuka Obinabo, Tim te Beek, Sam Snyder, Satvika Eda, Jonathan Schneider, Tim te Beek, Knut Wannheden, traceyyoshima, Tyler Van Gorder, Yifeng Jin, Adam Slaski, Aaron Gershman, Patrick, Daryl Robbins, Anu Ramamoorthy, Aaron Gershman, Tim te Beek, Jonathan Schnéider, Kun Li, Michael Keppler, Aakarshit Uppal, Shannon Pamperl, Tracey Yoshima, Kun Li, Josh Soref