Skip to main content

Find method usages

org.openrewrite.java.search.FindMethods

Find method calls by pattern.

Recipe source​

GitHub, 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.

Example​

Parameters​
ParameterValue
methodPatternjava.lang.Integer decode(..)
matchOverridesfalse
Before​
import java.lang.Integer
import java.lang.Integer.decode

val i1 = java.lang.Integer.decode("1")
val i2 = Integer.decode("1")
val i3 = decode("1")
val i4 = listOf("1").map {Integer::decode}
val i5 = listOf("1").map {::decode}
val i6 = listOf("1").map {::`decode`}
After​
import java.lang.Integer
import java.lang.Integer.decode

val i1 = /*~~>*/java.lang.Integer.decode("1")
val i2 = /*~~>*/Integer.decode("1")
val i3 = /*~~>*/decode("1")
val i4 = listOf("1").map {Integer::/*~~>*/decode}
val i5 = listOf("1").map {::/*~~>*/decode}
val i6 = listOf("1").map {::/*~~>*/`decode`}

Usage​

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly (unless you are running them via the Moderne CLI). 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.java.search.FindMethods:
      methodPattern: java.util.List add(..)

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

  1. Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("7.6.1")
}

rewrite {
    activeRecipe("com.yourorg.FindMethodsExample")
    setExportDatatables(true)
}

repositories {
    mavenCentral()
}
  1. Run gradle rewriteRun to run the recipe.

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.

Contributors​

Jonathan Schneider, Sam Snyder, Tim te Beek, Greg Adams, Tyler Van Gorder, Jonathan Leitschuh, Peter Streef, justine-gehring, Aaron Gershman