Skip to main content

Change type

org.openrewrite.java.ChangeType

Change a given type to another.

Recipe source​

GitHub, Issue Tracker, Maven Central

This recipe is available under the Apache License Version 2.0.

Options​

TypeNameDescriptionExample
StringoldFullyQualifiedTypeNameFully-qualified class name of the original type.org.junit.Assume
StringnewFullyQualifiedTypeNameFully-qualified class name of the replacement type, or the name of a primitive such as "int". The OuterClassName$NestedClassName naming convention should be used for nested classes.org.junit.jupiter.api.Assumptions
BooleanignoreDefinitionOptional. When set to true the definition of the old type will be left untouched. This is useful when you're replacing usage of a class but don't want to rename it.

Examples​

Example 1​
Parameters​
ParameterValue
oldFullyQualifiedTypeNamefile
newFullyQualifiedTypeNamenewFile
ignoreDefinitionfalse
Before​
class file {
}
After​
class newFile {
}
Example 2​
Parameters​
ParameterValue
oldFullyQualifiedTypeNamefile
newFullyQualifiedTypeNamenewFile
ignoreDefinitionfalse
Before​
class file {
}
After​
class newFile {
}
Example 3​
Parameters​
ParameterValue
oldFullyQualifiedTypeNamejava.util.logging.Logger
newFullyQualifiedTypeNameorg.apache.logging.log4j.Logger
ignoreDefinitiontrue
Before​
import java.util.logging.Logger;

class Test {
    void method(Logger logger) {
      logger.exiting("Test", "method");
      logger.exiting("Test", "method", "result");
    }
}
After​
import org.apache.logging.log4j.Logger;

class Test {
    void method(Logger logger) {
      logger.traceExit();
      logger.traceExit("result");
    }
}
Example 4​
Parameters​
ParameterValue
oldFullyQualifiedTypeNamejava.util.logging.Logger
newFullyQualifiedTypeNameorg.apache.logging.log4j.Logger
ignoreDefinitiontrue
Before​
import java.util.logging.Logger;

class Test {
    void method(Logger logger) {
      logger.entering("Test", "method");
      logger.entering("Test", "method", "param");
      logger.entering("Test", "method", new Object[]{"param1", "param2"});
    }
}
After​
import org.apache.logging.log4j.Logger;

class Test {
    void method(Logger logger) {
      logger.traceEntry();
      logger.traceEntry(null, "param");
      logger.traceEntry(null, new Object[]{"param1", "param2"});
    }
}

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.ChangeTypeExample. 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.ChangeTypeExample
displayName: Change type example
recipeList:
  - org.openrewrite.java.ChangeType:
      oldFullyQualifiedTypeName: org.junit.Assume
      newFullyQualifiedTypeName: org.junit.jupiter.api.Assumptions

Now that com.yourorg.ChangeTypeExample has been defined, activate it in your build file:

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

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

repositories {
    mavenCentral()
}
  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​

Tracey Yoshima, Jonathan Schneider, Laurens Westerlaken, Knut Wannheden, Tim te Beek, Sam Snyder, Nassim Jahnke, Kun Li, Greg Adams, Tyler Van Gorder, Joan Viladrosa, zac.kim, Michał Kosmulski, Jacob van Lingen, Ralph Sanders, Josh Soref, Adriano Machado, Patrick