Comment on page

Find method declaration

org.openrewrite.java.search.FindMethodDeclaration
Locates the declaration of a method.
Recipe source
​GitHub, Issue Tracker, Maven Central​
groupId: org.openrewrite
artifactId: rewrite-java
version: 8.9.5
Options
Type
Name
Description
String
methodPattern
A method pattern that is used to find matching method invocations.
Boolean
matchOverrides
Optional. When enabled, find methods that are overrides of the method pattern.
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.FindMethodDeclarationExample. 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.FindMethodDeclarationExample
displayName: Find method declaration example
recipeList:
  - org.openrewrite.java.search.FindMethodDeclaration:
      methodPattern: java.util.List add(..)
      matchOverrides: null
Now that com.yourorg.FindMethodDeclarationExample has been defined activate it in your build file:
Gradle
Maven
Moderne CLI
1.Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("6.5.6")
}
​
rewrite {
    activeRecipe("com.yourorg.FindMethodDeclarationExample")
}
​
repositories {
    mavenCentral()
}
2.Run gradle rewriteRun to run the recipe.
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.13.0</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.FindMethodDeclarationExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>
2.Run mvn rewrite:run to run the recipe.
You will need to have configured the Moderne CLI on your machine before you can run the following command.
shell
mod run . --recipe FindMethodDeclaration
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
​Sam Snyder​

Type	Name	Description
`String`	methodPattern	A method pattern that is used to find matching method invocations.
`Boolean`	matchOverrides	Optional. When enabled, find methods that are overrides of the method pattern.

Find literals

Find method usages

Last modified 12d ago