removeimplements.md

Remove interface implementations

org.openrewrite.java.RemoveImplements

Removes implements clauses from classes implementing the specified interface. Removes @Overrides annotations from methods which no longer override anything.

Source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite
• artifactId: rewrite-java
• version: 8.1.3

Options

Type	Name	Description
String	interfaceType	The fully qualified name of the interface to remove.
String	filter	Only apply the interface removal to classes with fully qualified names that begin with this filter. null or empty matches all classes.

Example

Parameters

Parameter	Value
interfaceType	java.io.Serializable
filter	null

{% tabs %} {% tab title="A.java" %}

Before

{% code title="A.java" %}

import java.io.Serializable;

class A implements Serializable {
}

{% endcode %}

After

{% code title="A.java" %}

class A {
}

{% endcode %}

{% endtab %} {% tab title="Diff" %} {% code %}

--- A.java
+++ A.java
@@ -1,3 +1,1 @@
-import java.io.Serializable;
-
-class A implements Serializable {
+class A {
}

{% endcode %} {% endtab %} {% endtabs %}

Usage

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly. 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.RemoveImplementsExample. Here's how you can define and customize such a recipe within your rewrite.yml:

{% code title="rewrite.yml" %}

---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.RemoveImplementsExample
displayName: Remove interface implementations example
recipeList:
  - org.openrewrite.java.RemoveImplements:
      interfaceType: java.io.Serializable
      filter: com.yourorg.

{% endcode %}

Now that com.yourorg.RemoveImplementsExample has been defined activate it in your build file: {% tabs %} {% tab title="Gradle" %} {% code title="build.gradle" %}

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

rewrite {
    activeRecipe("com.yourorg.RemoveImplementsExample")
}

repositories {
    mavenCentral()
}

{% endcode %} {% endtab %} {% tab title="Maven" %} {% code title="pom.xml" %}

<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.2.4</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.RemoveImplementsExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

{% endcode %} {% endtab %} {% endtabs %}

Contributors

• Sam Snyder
• Jonathan Schnéider

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.