Skip to main content

Change superclass

org.openrewrite.java.dropwizard.method.ChangeSuperType

Changes the superclass of a specified class to a new superclass.

Recipe source​

GitHub, Issue Tracker, Maven Central

This recipe is available under the Apache License Version 2.0.

Options​

TypeNameDescriptionExample
StringtargetClassThe fully qualified name of the class whose superclass should be changed.com.myorg.MyClass
StringnewSuperclassThe fully qualified name of the new superclass to extend or interface to implement.com.myorg.NewSuperclass
BooleankeepTypeParametersOptional. Whether to keep existing type parameters on the target class declaration.
BooleanconvertToInterfaceOptional. If the new supertype is an interface, setting this to true converts 'extends' to 'implements'.
BooleanremoveUnnecessaryOverridesOptional. Remove method Override annotations that override methods from the old superclass but are no longer necessary with the new superclass.

Example​

Parameters​
ParameterValue
targetClassjava.util.Vector
newSuperclassjava.util.ArrayList
keepTypeParametersfalse
convertToInterfacefalse
removeUnnecessaryOverridesfalse
Before​
package org.example;

public class Child extends java.util.Vector<String> {
    public void someMethod() {
        this.add("test");
    }
}
After​
package org.example;

import java.util.ArrayList;

public class Child extends ArrayList {
    public void someMethod() {
        this.add("test");
    }
}

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.ChangeSuperTypeExample. 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.ChangeSuperTypeExample
displayName: Change superclass example
recipeList:
  - org.openrewrite.java.dropwizard.method.ChangeSuperType:
      targetClass: com.myorg.MyClass
      newSuperclass: com.myorg.NewSuperclass

Now that com.yourorg.ChangeSuperTypeExample has been defined, activate it and take a dependency on org.openrewrite.recipe:rewrite-dropwizard:0.1.0 in your build file:

  1. Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("7.7.0")
}

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

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-dropwizard:0.1.0")
}
  1. Run gradle rewriteRun to run the recipe.

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

Run this recipe on OSS repos at scale with the Moderne SaaS.

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​

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.

Contributors​

Karl-Erik Hein