Change type
org.openrewrite.java.ChangeType
Change a given type to another.
- groupId: org.openrewrite
- artifactId: rewrite-java
- version: 8.6.0
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. |
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: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
Now that
com.yourorg.ChangeTypeExample
has been defined activate it in your build file:Gradle
Maven
- 1.Add the following to your
build.gradle
file:
build.gradle
plugins {
id("org.openrewrite.rewrite") version("6.3.11")
}
rewrite {
activeRecipe("com.yourorg.ChangeTypeExample")
}
repositories {
mavenCentral()
}
- 2.Run
gradle rewriteRun
to run the recipe.
- 1.Add the following to your
pom.xml
file:
pom.xml
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>5.5.2</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.ChangeTypeExample</recipe>
</activeRecipes>
</configuration>
</plugin>
</plugins>
</build>
</project>
- 2.Run
mvn rewrite:run
to run the recipe.
- Tyler Van Gorder
- Josh Soref
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.