Open source

Add a `null` method argument

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

Add a null argument to method invocations.

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

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.AddNullMethodArgument --recipe-option "methodPattern=com.yourorg.A foo(int, int)" --recipe-option "argumentIndex=0" --recipe-option "parameterType=java.lang.String"

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(int, int)`
`argumentIndex`required	`int`	A zero-based index that indicates which argument will be added as null to the method invocation. e.g. `0`
`parameterType`required	`String`	The type of the parameter that we add the argument for. e.g. `java.lang.String`
`parameterName`	`String`	The name of the parameter that we add the argument for. e.g. `name`
`explicitCast`	`Boolean`	Explicitly cast the argument to the parameter type. Useful if the method is overridden with another type. e.g. `true`

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