Find types
org.openrewrite.java.search.FindTypes
Find type references by name.
- groupId: org.openrewrite
- artifactId: rewrite-java
- version: 8.6.0
Type | Name | Description |
|---|---|---|
String | fullyQualifiedTypeName | A fully-qualified type name, that is used to find matching type references. Supports glob expressions. java..* finds every type from every subpackage of the java package. |
Boolean | checkAssignability | Optional. When enabled, find type references that are assignable to the provided type. |
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.FindTypesExample. 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.FindTypesExample
displayName: Find types example
recipeList:
- org.openrewrite.java.search.FindTypes:
fullyQualifiedTypeName: java.util.List
checkAssignability: null
Now that
com.yourorg.FindTypesExample has been defined activate it in your build file:Gradle
Maven
- 1.Add the following to your
build.gradlefile:
build.gradle
plugins {
id("org.openrewrite.rewrite") version("6.3.11")
}
rewrite {
activeRecipe("com.yourorg.FindTypesExample")
}
repositories {
mavenCentral()
}
- 2.Run
gradle rewriteRunto run the recipe.
- 1.Add the following to your
pom.xmlfile:
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.FindTypesExample</recipe>
</activeRecipes>
</configuration>
</plugin>
</plugins>
</build>
</project>
- 2.Run
mvn rewrite:runto run the recipe.
- Tyler Van Gorder
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.