Upgrade Java version
org.openrewrite.java.migrate.UpgradeJavaVersionorg.openrewrite.recipe:rewrite-migrate-javaUpgrade build plugin configuration to use the specified Java version. This recipe changes java.toolchain.languageVersion in build.gradle(.kts) of gradle projects, or maven-compiler-plugin target version and related settings. Will not downgrade if the version is newer than the specified version.
Recipe source
Definition
- Recipe list
- YAML
---
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.UpgradeJavaVersion
displayName: Upgrade Java version
description: |
Upgrade build plugin configuration to use the specified Java version. This recipe changes `java.toolchain.languageVersion` in `build.gradle(.kts)` of gradle projects, or maven-compiler-plugin target version and related settings. Will not downgrade if the version is newer than the specified version.
recipeList:
- org.openrewrite.maven.UseMavenCompilerPluginReleaseConfiguration
- org.openrewrite.maven.UpdateMavenProjectPropertyJavaVersion
- org.openrewrite.jenkins.UpgradeJavaVersion
- org.openrewrite.gradle.UpdateJavaCompatibility:
allowDowngrade: false
- org.openrewrite.java.migrate.UpdateSdkMan:
newVersion: null
- org.openrewrite.java.migrate.UpgradeDockerImageVersion
Used by
This recipe is used as part of the following composite recipes (from the open-source catalog):
- Migrate from Micronaut 3.x to 4.x
- Migrate from Micronaut 4.x to 5.x
- Migrate to Java 8
- Upgrade Java to 11+ for Kafka clients
- Upgrade Java to 17+ for Kafka broker/tools
- Upgrade build to Java 11
- Upgrade build to Java 17
- Upgrade build to Java 21
- Upgrade build to Java 24 for Kotlin pre-2.3
- Upgrade build to Java 25 (non-Kotlin)
- Upgrade build to Java 25 for Kotlin 2.3+
Examples
pom.xml
| Parameter | Value |
|---|---|
| version | 17 |
- pom.xml
- Diff
<project>
<modelVersion>4.0.0</modelVersion>
<properties>
<java.version>1.8</java.version>
<maven.compiler.source>1.8</maven.compiler.source>
<maven.compiler.target>1.8</maven.compiler.target>
</properties>
<groupId>com.mycompany.app</groupId>
<artifactId>my-app</artifactId>
<version>1</version>
</project>
<project>
<modelVersion>4.0.0</modelVersion>
<properties>
<java.version>17</java.version>
<maven.compiler.source>17</maven.compiler.source>
<maven.compiler.target>17</maven.compiler.target>
</properties>
<groupId>com.mycompany.app</groupId>
<artifactId>my-app</artifactId>
<version>1</version>
</project>
--- pom.xml
+++ pom.xml
@@ -5,3 +5,3 @@
<properties>
- <java.version>1.8</java.version>
- <maven.compiler.source>1.8</maven.compiler.source>
- <maven.compiler.target>1.8</maven.compiler.target>
+ <java.version>17</java.version>
+ <maven.compiler.source>17</maven.compiler.source>
+ <maven.compiler.target>17</maven.compiler.target>
</properties>
Usage
Run this recipe
You will need to have configured the Moderne CLI on your machine before you can run the following command.
mod run . --recipe UpgradeJavaVersion --recipe-option "version=11"
If the recipe is not available locally, then you can install it using:
mod config recipes jar install org.openrewrite.recipe:rewrite-migrate-java:3.36.0
See how this recipe works across thousands of OSS repositories
Run this recipe at scale on the Moderne Platform and review every change before it lands.
Data tables
Source files that had results
org.openrewrite.table.SourcesFileResultsSource files that were modified by the recipe run.
| Column | Description |
|---|---|
| Source path before the run | The source path of the file before the run. null when a source file was created during the run. |
| Source path after the run | A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run. |
| Parent of the recipe that made changes | In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all. |
| Recipe that made changes | The specific recipe that made a change. |
| Estimated time saving | An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds. |
| Cycle | The recipe cycle in which the change was made. |
Source files that had search results
org.openrewrite.table.SearchResultsSearch results that were found during the recipe run.
| Column | Description |
|---|---|
| Source path of search result before the run | The source path of the file with the search result markers present. |
| Source path of search result after run the run | A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run. |
| Result | The trimmed printed tree of the LST element that the marker is attached to. |
| Description | The content of the description of the marker. |
| Recipe that added the search marker | The specific recipe that added the Search marker. |
Source files that errored on a recipe
org.openrewrite.table.SourcesFileErrorsThe details of all errors produced by a recipe run.
| Column | Description |
|---|---|
| Source path | The file that failed to parse. |
| Recipe that made changes | The specific recipe that made a change. |
| Stack trace | The stack trace of the failure. |
Recipe performance
org.openrewrite.table.RecipeRunStatsStatistics used in analyzing the performance of recipes.
| Column | Description |
|---|---|
| The recipe | The recipe whose stats are being measured both individually and cumulatively. |
| Source file count | The number of source files the recipe ran over. |
| Source file changed count | The number of source files which were changed in the recipe run. Includes files created, deleted, and edited. |
| Cumulative scanning time (ns) | The total time spent across the scanning phase of this recipe. |
| Max scanning time (ns) | The max time scanning any one source file. |
| Cumulative edit time (ns) | The total time spent across the editing phase of this recipe. |
| Max edit time (ns) | The max time editing any one source file. |
Structured datain <head> — not rendered on the page
This SoftwareSourceCode JSON-LD is injected into the page’s<head> and is invisible to readers in production — it’s shown here only so you can see the markup.
{
"@context": "https://schema.org",
"@type": "SoftwareSourceCode",
"name": "Upgrade Java version",
"identifier": "org.openrewrite.java.migrate.UpgradeJavaVersion",
"description": "Upgrade build plugin configuration to use the specified Java version. This recipe changes java.toolchain.languageVersion in build.gradle(.kts) of gradle projects, or maven-compiler-plugin target version and related settings. Will not downgrade if the version is newer than the specified version.",
"codeRepository": "https://github.com/openrewrite/rewrite-migrate-java",
"programmingLanguage": [
"Java",
"Maven",
"Gradle"
],
"license": "https://www.apache.org/licenses/LICENSE-2.0"
}