Skip to main content

Find method usages

org.openrewrite.java.search.FindMethods

Find method calls by pattern.

info

This Java recipe works on Python code.

Recipe source​

GitHub: FindMethods.java, Issue Tracker, Maven Central

This recipe is available under the Apache License Version 2.0.

Options​

TypeNameDescriptionExample
StringmethodPatternA method pattern is used to find matching method invocations. For example, to find all method invocations in the Guava library, use the pattern: com.google.common..*#*(..).

The pattern format is <PACKAGE>#<METHOD_NAME>(<ARGS>).

..* includes all subpackages of com.google.common.
*(..) matches any method name with any number of arguments.

For more specific queries, like Guava's ImmutableMap, use com.google.common.collect.ImmutableMap#*(..) to narrow down the results.		java.util.List add(..)
BooleanmatchOverridesOptional. When enabled, find methods that are overrides of the method pattern.

Used by​

This recipe is used as part of the following composite recipes:

Example​

Parameters​
ParameterValue
methodPatternA <constructor>(String)
matchOverridesfalse
Unchanged​
class A {
    public A(String s) {}
}
Before​
class Test {
    A a = new A("test");
}
After​
class Test {
    A a = /*~~>*/new A("test");
}

Usage​

This recipe has required configuration parameters and can only be run by users of Moderne. To run this recipe, you will need to provide the Moderne CLI run command with the required options. Or, if you'd like to create a declarative recipe, please see the below example of a rewrite.yml file:

rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.FindMethodsExample
displayName: Find method usages example
recipeList:
  - org.openrewrite.java.search.FindMethods:
      methodPattern: java.util.List add(..)

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell
mod run . --recipe FindMethods --recipe-option "methodPattern=java.util.List add(..)"

If the recipe is not available locally, then you can install it using:

mod config recipes jar install org.openrewrite:rewrite-java:8.73.2

See how this recipe works across multiple open-source repositories​

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

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​

Method calls​

org.openrewrite.java.table.MethodCalls

The text of matching method invocations.

Column NameDescription
Source fileThe source file that the method call occurred in.
Method callThe text of the method call.
Class nameThe class name of the method call.
Method nameThe method name of the method call.
Argument typesThe argument types of the method call.