Find which Java version is in use

org.openrewrite.java.migrate.search.AboutJavaVersion

A diagnostic for studying the distribution of Java language version levels (both source and target compatibility across files and source sets).

Recipe source

GitHub, Issue Tracker, Maven Central

This recipe is available under the Moderne Source Available License.

Options

Type	Name	Description	Example
String	whenUsesType	Optional. Only mark the Java version when this type is in use.	lombok.val

Example

Parameters

Parameter	Value
whenUsesType	null

java

Before

class Test {
}

After

/*~~(Java version: 11)~~>*/class Test {
}

Diff

@@ -1,1 +1,1 @@
-class Test {
+/*~~(Java version: 11)~~>*/class Test {
}

java

Before

class Test2 {
}

After

/*~~(Java version: 11)~~>*/class Test2 {
}

Diff

@@ -1,1 +1,1 @@
-class Test2 {
+/*~~(Java version: 11)~~>*/class Test2 {
}

Usage

This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-migrate-java 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("7.6.1")
}

rewrite {
    activeRecipe("org.openrewrite.java.migrate.search.AboutJavaVersion")
    setExportDatatables(true)
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-migrate-java:3.9.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:7.6.1") }
}
rootProject {
    plugins.apply(org.openrewrite.gradle.RewritePlugin)
    dependencies {
        rewrite("org.openrewrite.recipe:rewrite-migrate-java:3.9.0")
    }
    rewrite {
        activeRecipe("org.openrewrite.java.migrate.search.AboutJavaVersion")
        setExportDatatables(true)
    }
    afterEvaluate {
        if (repositories.isEmpty()) {
            repositories {
                mavenCentral()
            }
        }
    }
}

2. Run the recipe.

shell

gradle --init-script init.gradle rewriteRun

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>6.8.0</version>
        <configuration>
          <exportDatatables>true</exportDatatables>
          <activeRecipes>
            <recipe>org.openrewrite.java.migrate.search.AboutJavaVersion</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-migrate-java</artifactId>
            <version>3.9.0</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>

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

Maven Command Line

You will need to have Maven installed on your machine before you can run the following command.

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.search.AboutJavaVersion -Drewrite.exportDatatables=true

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 AboutJavaVersion

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.9.0

See how this recipe works across multiple open-source repositories

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

Run this recipe here

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

JavaVersionPerSourceSet

Java versions by source set

org.openrewrite.java.migrate.table.JavaVersionPerSourceSet

A per-source set view of Java version in use.

Column Name	Description
Project name	The module name (useful especially for multi-module repositories).
Source set name	The source set, e.g. main or test.
Created by	The JDK release that was used to compile the source file.
VM vendor	The vendor of the JVM that was used to compile the source file.
Source compatibility	The source compatibility of the source file.
Major version source compatibility	The major version.
Target compatibility	The target compatibility or --release version of the source file.

SourcesFileResults

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column Name	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.

SourcesFileErrors

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Column Name	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.

RecipeRunStats

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Column Name	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.
99th percentile scanning time (ns)	99 out of 100 scans completed in this amount of time.
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.
99th percentile edit time (ns)	99 out of 100 edits completed in this amount of time.
Max edit time (ns)	The max time editing any one source file.

Contributors

Jonathan Schneider, Sam Snyder, Tim te Beek