Skip to main content

Update Gradle project Java compatibility

org.openrewrite.gradle.UpdateJavaCompatibility

Find and updates the Java compatibility for the Gradle project.

Recipe source​

GitHub: UpdateJavaCompatibility.java, Issue Tracker, Maven Central

This recipe is available under the Apache License Version 2.0.

Options​

TypeNameDescriptionExample
IntegerversionThe Java version to upgrade to.11
CompatibilityTypecompatibilityTypeOptional. The compatibility type to change Valid options: source, target
DeclarationStyledeclarationStyleOptional. The desired style to write the new version as when being written to the sourceCompatibility or targetCompatibility variables. Default, match current source style. (ex. Enum: JavaVersion.VERSION_11, Number: 11, or String: "11") Valid options: Enum, Number, String
BooleanallowDowngradeOptional. Allow downgrading the Java version.
BooleanaddIfMissingOptional. Adds the specified compatibility type if one is not found.

Used by​

This recipe is used as part of the following composite recipes:

Example​

Parameters​
ParameterValue
version11
compatibilityTypeUpdateJavaCompatibility.CompatibilityType.source
declarationStylenull
allowDowngradenull
addIfMissingnull
Before​
build.gradle
plugins {
    id "java"
}

sourceCompatibility = 1.8
targetCompatibility = 1.8
After​
build.gradle
plugins {
    id "java"
}

sourceCompatibility = 11
targetCompatibility = 1.8

Usage​

This recipe has required configuration parameters and can only be run by users of Moderne. To run this recipe, you will need to provide the Moderne CLI run command with the required options. Or, if you'd like to create a declarative recipe, please see the below example of a rewrite.yml file:

rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.UpdateJavaCompatibilityExample
displayName: Update Gradle project Java compatibility example
recipeList:
  - org.openrewrite.gradle.UpdateJavaCompatibility:
      version: 11

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

shell
mod run . --recipe UpdateJavaCompatibility --recipe-option "version=11"

If the recipe is not available locally, then you can install it using:

mod config recipes jar install org.openrewrite:rewrite-gradle:8.74.0

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

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.

Data Tables​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA 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 changesIn 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 changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.