Change method target to static

org.openrewrite.java.ChangeMethodTargetToStatic

Change method invocations to static method calls.

Recipe source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite

• artifactId: rewrite-java

• version: 8.23.1

Options

Type	Name	Description	Example
String	methodPattern	A method pattern that is used to find matching method invocations. The original method call may or may not be a static method invocation.	com.google.common.collect.ImmutableSet of(..)
String	fullyQualifiedTargetTypeName	A fully-qualified class name of the type upon which the static method is defined.	java.util.Set
String	returnType	Optional. Sometimes changing the target type also changes the return type. In the Guava example, changing from ImmutableSet#of(..) to Set#of(..) widens the return type from Guava's ImmutableSet to just java.util.Set.	java.util.Set
Boolean	matchOverrides	Optional. When enabled, find methods that are overrides of the method pattern.
Boolean	matchUnknownTypes	Optional. When enabled, include method invocations which appear to match if full type information is missing. Using matchUnknownTypes can improve recipe resiliency for an AST with missing type information, but also increases the risk of false-positive matches on unrelated method invocations.

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.ChangeMethodTargetToStaticExample. 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.ChangeMethodTargetToStaticExample
displayName: Change method target to static example
recipeList:
  - org.openrewrite.java.ChangeMethodTargetToStatic:
      methodPattern: com.google.common.collect.ImmutableSet of(..)
      fullyQualifiedTargetTypeName: java.util.Set
      returnType: java.util.Set

Now that com.yourorg.ChangeMethodTargetToStaticExample 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.11.2")
}

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

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.27.0</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.ChangeMethodTargetToStaticExample</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 ChangeMethodTargetToStaticExample

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

Jonathan Schneider, Nick McKinney, Greg Adams, Tyler Van Gorder, traceyyoshima, Sam Snyder, Aaron Gershman, Tim te Beek