Find method usages

org.openrewrite.analysis.search.FindMethods

Find method usages by pattern.

Recipe source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite.meta

• artifactId: rewrite-analysis

• version: 2.6.0

Options

Type	Name	Description	Example
String	methodPattern	A method pattern that is used to find matching method invocations.	java.util.List add(..)
Boolean	matchOverrides	Optional. When enabled, find methods that are overrides of the method pattern.
String	flow	Optional. When enabled, show the data or taint flow of the method invocation. Valid options: none, data, taint

Data Tables (Only available on the Moderne platform)

Method calls

The text of matching method invocations.

Column Name	Description
Source file	The source file that the method call occurred in.
Method call	The text of the method call.
Class name	The class name of the method call.
Method name	The method name of the method call.
Argument types	The argument types of the method call.

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.FindMethodsExample. 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.FindMethodsExample
displayName: Find method usages example
recipeList:
  - org.openrewrite.analysis.search.FindMethods:
      methodPattern: java.util.List add(..)

Now that com.yourorg.FindMethodsExample has been defined activate it and take a dependency on org.openrewrite.meta:rewrite-analysis:2.6.0 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.FindMethodsExample")
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.meta:rewrite-analysis:2.6.0")
}

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.FindMethodsExample</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.meta</groupId>
            <artifactId>rewrite-analysis</artifactId>
            <version>2.6.0</version>
          </dependency>
        </dependencies>
      </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 FindMethodsExample

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 Leitschuh, Knut Wannheden, aaronist, Tim te Beek, Jonathan Schnéider