Open source

Generate InlineMethodCalls recipes for deprecated delegating methods

Recipe IDorg.openrewrite.java.recipes.GenerateDeprecatedMethodRecipes

Artifactorg.openrewrite.recipe:rewrite-rewrite

Finds @Deprecated method declarations whose body is a single delegation call to another method in the same class, and generates a declarative YAML recipe file containing InlineMethodCalls entries for each.

Single recipeJavaModerne Source Available License

Try in PlatformTry this recipe in the Moderne platform. Not a user yet? You’ll get a no-setup demo environment, with nothing to install or configure.

Examples

yaml

Unchanged

package com.example;

public class Foo {
    private final String a;
    private final String b;

    public Foo(String a, String b) {
        this.a = a;
        this.b = b;
    }

    @Deprecated
    public Foo(String a) {
        this(a, null);
    }
}

yaml

New file

type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.recipes.InlineDeprecatedMethods
displayName: Inline deprecated delegating methods
description: Automatically generated recipes to inline deprecated method calls that delegate to other methods in the same class.
recipeList:
  - org.openrewrite.java.InlineMethodCalls:
      methodPattern: 'com.example.Foo <constructor>(java.lang.String)'
      replacement: 'this(a, null)'

Usage

Run this recipe

This recipe has no required configuration options. Users of Moderne can run it via the Moderne CLI.

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell

mod run . --recipe GenerateDeprecatedMethodRecipes

If the recipe is not available locally, then you can install it using:

RELEASE resolves to the newest release and LATEST to the newest build of any kind, including snapshots. Either one lets mod config recipes upgrade pull in later versions without editing this command; a pinned version stays where you put it.

RELEASE

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

LATEST

mod config recipes jar install org.openrewrite.recipe:rewrite-rewrite:LATEST

Pinned version

mod config recipes jar install org.openrewrite.recipe:rewrite-rewrite:0.32.0

Data tables

Deprecated method delegations

org.openrewrite.java.recipes.DeprecatedMethodDelegations

Deprecated methods that delegate to another method in the same class, suitable for inlining via InlineMethodCalls.

Column	Description
Method pattern	The method pattern of the deprecated method.
Replacement	The replacement expression to inline.
Recipe YAML	A YAML snippet that can be copied into a recipe list.

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column	Description
Source path before the run	The source path of the file before the run. null when a source file was created during the run.
Source path after the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changes	In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changes	The specific recipe that made a change.
Estimated time saving	An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
Cycle	The recipe cycle in which the change was made.

Source files that had search results

org.openrewrite.table.SearchResults

Search results that were found during the recipe run.

Column	Description
Source path of search result before the run	The source path of the file with the search result markers present.
Source path of search result after run the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Result	The trimmed printed tree of the LST element that the marker is attached to.
Description	The content of the description of the marker.
Recipe that added the search marker	The specific recipe that added the Search marker.

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Column	Description
Source path	The file that failed to parse.
Recipe that made changes	The specific recipe that made a change.
Stack trace	The stack trace of the failure.

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Column	Description
The recipe	The recipe whose stats are being measured both individually and cumulatively.
Source file count	The number of source files the recipe ran over.
Source file changed count	The number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time (ns)	The total time spent across the scanning phase of this recipe.
Max scanning time (ns)	The max time scanning any one source file.
Cumulative edit time (ns)	The total time spent across the editing phase of this recipe.
Max edit time (ns)	The max time editing any one source file.