Design Partners
Change method name
** org.openrewrite.java.ChangeMethodName** Rename a method.

Source

  • groupId: org.openrewrite
  • artifactId: rewrite-java
  • version: 7.22.0

Options

Type
Name
Description
String
methodPattern
A method pattern that is used to find matching method declarations/invocations.
String
newMethodName
The method name that will replace the existing name.
Boolean
matchOverrides
Optional. When enabled, find methods that are overrides of the method pattern.
Boolean
ignoreDefinition
Optional. When set to true the definition of the old type will be left untouched. This is useful when you're replacing usage of a class but don't want to rename it.

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.ChangeMethodNameExample. Here's how you can define and customize such a recipe within your rewrite.yml:
rewrite.yml
1
---
2
type: specs.openrewrite.org/v1beta/recipe
3
name: com.yourorg.ChangeMethodNameExample
4
displayName: Change method name example
5
recipeList:
6
- org.openrewrite.java.ChangeMethodName:
7
methodPattern: org.mockito.Matchers anyVararg()
8
newMethodName: any
9
matchOverrides: null
10
ignoreDefinition: true
Copied!
Now that com.yourorg.ChangeMethodNameExample has been defined activate it in your build file:
Gradle
Maven
build.gradle
1
plugins {
2
id("org.openrewrite.rewrite") version("5.20.0")
3
}
4
5
rewrite {
6
activeRecipe("com.yourorg.ChangeMethodNameExample")
7
}
8
9
repositories {
10
mavenCentral()
11
}
Copied!
pom.xml
1
<project>
2
<build>
3
<plugins>
4
<plugin>
5
<groupId>org.openrewrite.maven</groupId>
6
<artifactId>rewrite-maven-plugin</artifactId>
7
<version>4.23.0</version>
8
<configuration>
9
<activeRecipes>
10
<recipe>com.yourorg.ChangeMethodNameExample</recipe>
11
</activeRecipes>
12
</configuration>
13
</plugin>
14
</plugins>
15
</build>
16
</project>
Copied!
Recipes can also be activated directly from the commandline by adding the argument -Drewrite.activeRecipes=com.yourorg.ChangeMethodNameExample
Export as PDF
Copy link