Change static field access to static method access

org.openrewrite.java.ChangeStaticFieldToMethod

Migrate accesses to a static field to invocations of a static method.

Recipe source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite

• artifactId: rewrite-java

• version: 8.24.0

Options

Type	Name	Description	Example
String	oldClassName	The fully qualified name of the class containing the field to replace.	java.util.Collections
String	oldFieldName	The simple name of the static field to replace.	EMPTY_LIST
String	newClassName	Optional. The fully qualified name of the class containing the method to use. Leave empty to keep the same class.	java.util.List
String	newTarget	Optional. An optional method target that can be used to specify a static field within the new class.	OK_RESPONSE
String	newMethodName	The simple name of the method to use. The method must be static and have no arguments.	of

Usage

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly. To activate this recipe you must create a new recipe which fills in the required parameters. In your rewrite.yml create a new recipe with a unique name. For example: com.yourorg.ChangeStaticFieldToMethodExample. Here's how you can define and customize such a recipe within your rewrite.yml:

rewrite.yml

---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.ChangeStaticFieldToMethodExample
displayName: Change static field access to static method access example
recipeList:
  - org.openrewrite.java.ChangeStaticFieldToMethod:
      oldClassName: java.util.Collections
      oldFieldName: EMPTY_LIST
      newClassName: java.util.List
      newTarget: OK_RESPONSE
      newMethodName: of

Now that com.yourorg.ChangeStaticFieldToMethodExample has been defined activate it in your build file:

Gradle

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

build.gradle

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

rewrite {
    activeRecipe("com.yourorg.ChangeStaticFieldToMethodExample")
}

repositories {
    mavenCentral()
}

2. Run gradle rewriteRun to run the recipe.

Maven

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>com.yourorg.ChangeStaticFieldToMethodExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

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

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 ChangeStaticFieldToMethodExample

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

Christian Semrau, Jonathan Schnéider, Tyler Van Gorder, traceyyoshima, Sam Snyder, Tim te Beek, Knut Wannheden, Thomas Zub, Aaron Gershman