Find types

org.openrewrite.java.search.FindTypes

Find type references by name.

Recipe source

GitHub, Issue Tracker, Maven Central

  • groupId: org.openrewrite

  • artifactId: rewrite-java

  • version: 8.21.0

Options

TypeNameDescriptionExample

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.

java.util.List

Boolean

checkAssignability

Optional. When enabled, find type references that are assignable to the provided type.

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.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

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

rewrite {
    activeRecipe("com.yourorg.FindTypesExample")
}

repositories {
    mavenCentral()
}
  1. Run gradle rewriteRun to run the recipe.

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.

Contributors

Jonathan Schneider, Greg Adams, Tracey Yoshima, Tyler Van Gorder, Tim te Beek

Last updated