Skip to main content

Find types

org.openrewrite.java.search.FindTypes

Find type references by name.

Recipe source​

GitHub, Issue Tracker, Maven Central

This recipe is available under the Apache License Version 2.0.

Options​

TypeNameDescriptionExample
StringfullyQualifiedTypeNameA 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
BooleancheckAssignabilityOptional. When enabled, find type references that are assignable to the provided type.

Example​

Parameters​
ParameterValue
fullyQualifiedTypeNameorg.junit.jupiter.api.Test
checkAssignabilitynull
Before​
import org.junit.jupiter.api.Test
class A {
    Test t
}
After​
import org.junit.jupiter.api.Test
class A {
    /*~~>*/Test t
}

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.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("7.6.1")
}

rewrite {
    activeRecipe("com.yourorg.FindTypesExample")
    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​

Type uses​

org.openrewrite.java.table.TypeUses

The source code of matching type uses.

Column NameDescription
Source fileThe source file that the method call occurred in.
SourceThe source code of the type use.
Concrete typeThe concrete type in use, which may be a subtype of a searched type.

Contributors​

Jonathan Schneider, Laurens Westerlaken, Greg Adams, Sam Snyder, Tyler Van Gorder, Jacob van Lingen, Tim te Beek