Open source

Reorder method arguments

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

Reorder method arguments into the specified order.

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.ReorderMethodArguments")
}

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.ReorderMethodArguments --recipe-option "methodPattern=com.yourorg.A foo(String, Integer, Integer)" --recipe-option "newParameterNames=[foo, bar, baz]"

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. `com.yourorg.A foo(String, Integer, Integer)`
`newParameterNames`required	`String[]`	An array of parameter names that indicates the new order in which those arguments should be arranged. e.g. `[foo, bar, baz]`
`oldParameterNames`	`String[]`	If the original method signature is not type-attributed, this is an optional list that indicates the original order in which the arguments were arranged. e.g. `[baz, bar, foo]`
`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.
`matchOverrides`	`Boolean`	When enabled, find methods that are overrides of the method pattern.

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