Home Original page

Adds missing method implementations | OpenRewrite Docs

org.openrewrite.java.migrate.AddMissingMethodImplementation

Check for missing methods required by interfaces and adds them.

Recipe source​

GitHub: AddMissingMethodImplementation.java, Issue Tracker, Maven Central

This recipe is available under the Moderne Source Available License.

Options​

TypeNameDescriptionExample
StringfullyQualifiedClassNameA fully qualified class being implemented with missing method.com.yourorg.FooBar
StringmethodPatternA method pattern for matching required method definition.*..* hello(..)
StringmethodTemplateStringTemplate of method to addpublic String hello() { return \"Hello from #{}!\"; }

Used by​

This recipe is used as part of the following composite recipes:

Example​

Parameters​
ParameterValue
fullyQualifiedClassNameI1
methodPattern*..* m1()
methodTemplateStringpublic void m1() { System.out.println("m1"); }
  • java
  • Diff
Before​
interface I1 {}
class C2 implements I1 {}
After​
interface I1 {}
class C2 implements I1 {
    public void m1() {
        System.out.println("m1");
    }}

Usage​

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly (unless you are running them via the Moderne CLI). 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.AddMissingMethodImplementationExample. Here's how you can define and customize such a recipe within your rewrite.yml:

rewrite.yml

---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.AddMissingMethodImplementationExample
displayName: Adds missing method implementations example
recipeList:
  - org.openrewrite.java.migrate.AddMissingMethodImplementation:
      fullyQualifiedClassName: com.yourorg.FooBar
      methodPattern: '*..* hello(..)'
      methodTemplateString: public String hello() { return \"Hello from #{}!\"; }

Now that com.yourorg.AddMissingMethodImplementationExample has been defined, activate it and take a dependency on org.openrewrite.recipe:rewrite-migrate-java:3.31.1 in your build file:

  • Gradle
  • Maven POM
  • Moderne CLI
  1. Add the following to your build.gradle file:

    build.gradle

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

    rewrite {
        activeRecipe("com.yourorg.AddMissingMethodImplementationExample")
        setExportDatatables(true)
    }

    repositories {
        mavenCentral()
    }

    dependencies {
        rewrite("org.openrewrite.recipe:rewrite-migrate-java:3.31.1")
    }
  2. Run gradle rewriteRun to run the recipe.

See how this recipe works across multiple open-source repositories​

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Data Tables​

  • SourcesFileResults
  • SearchResults
  • SourcesFileErrors
  • RecipeRunStats

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA 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 changesIn 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 changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.