Open source

Change method name

Recipe IDorg.openrewrite.java.ChangeMethodNameArtifactorg.openrewrite:rewrite-java

Rename a method.

Single recipeApache 2.0

Add to your build

Get a download tokenSign in with GitHub or Google, and your token replaces YOUR_DOWNLOAD_TOKEN below. Free for open source recipes like this one.

~/.gradle/gradle.properties

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

build.gradle.kts

plugins {
    id("org.openrewrite.rewrite") version("latest.release")
}

rewrite {
    activeRecipe("org.openrewrite.java.ChangeMethodName")
}

repositories {
    mavenCentral()
    maven {
        url = uri("https://artifacts.codegenomeproject.org/maven")
        credentials {
            username = providers.gradleProperty("codeGenomeUsername").get()
            password = providers.gradleProperty("codeGenomeToken").get()
        }
    }
}

dependencies {
    rewrite("org.openrewrite:rewrite-java:8.92.8")
}

Then run

./gradlew rewriteRun

This recipe has required options, which a build sets in a rewrite.yml recipe that you activate instead.

Usage

You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.java.ChangeMethodName --recipe-option "methodPattern=org.mockito.Matchers anyVararg()" --recipe-option "newMethodName=any"

If the recipe isn’t available locally, install it with:

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

Options

Name	Type	Description
`methodPattern`required	`String`	A 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. e.g. `org.mockito.Matchers anyVararg()`
`newMethodName`required	`String`	The method name that will replace the existing name. e.g. `any`
`matchOverrides`	`Boolean`	When enabled, find methods that are overrides of the method pattern.
`ignoreDefinition`	`Boolean`	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.

Data tables

Structured output this recipe can produce.

Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats