changetype.md

Change type

org.openrewrite.java.ChangeType

Change a given type to another.

Source

GitHub, Issue Tracker, Maven Central

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

Options

Type	Name	Description
String	oldFullyQualifiedTypeName	Fully-qualified class name of the original type.
String	newFullyQualifiedTypeName	Fully-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.
Boolean	ignoreDefinition	Optional. 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

Parameter	Value
oldFullyQualifiedTypeName	file
newFullyQualifiedTypeName	newFile
ignoreDefinition	false

{% tabs %} {% tab title="file.kt" %}

Before

{% code title="file.kt" %}

class file {
}

{% endcode %}

After

{% code title="file.kt" %}

class newFile {
}

{% endcode %}

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

--- file.kt
+++ file.kt
@@ -1,1 +1,1 @@
-class file {
+class newFile {
}

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

---

Example 2

Parameters

Parameter	Value
oldFullyQualifiedTypeName	file
newFullyQualifiedTypeName	newFile
ignoreDefinition	false

{% tabs %} {% tab title="file.groovy" %}

Before

{% code title="file.groovy" %}

class file {
}

{% endcode %}

After

{% code title="file.groovy" %}

class newFile {
}

{% endcode %}

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

--- file.groovy
+++ file.groovy
@@ -1,1 +1,1 @@
-class file {
+class newFile {
}

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

---

Example 3

Parameters

Parameter	Value
oldFullyQualifiedTypeName	java.lang.Integer
newFullyQualifiedTypeName	java.lang.Long
ignoreDefinition	true

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

Before

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

public class ThinkPositive { private Integer fred = 1;}

{% endcode %}

After

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

public class ThinkPositive { private Long fred = 1;}

{% endcode %}

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

--- ThinkPositive.java
+++ ThinkPositive.java
@@ -1,1 +1,1 @@
-public class ThinkPositive { private Integer fred = 1;}
+public class ThinkPositive { private Long fred = 1;}

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

{% endcode %}

Now that com.yourorg.ChangeTypeExample 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.ChangeTypeExample")
}

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.ChangeTypeExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

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

Contributors

• Tracey Yoshima
• Jonathan Schneider
• Sam Snyder
• Greg Adams
• Tyler Van Gorder
• Josh Soref
• Patrick

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.