Comment on page

Find fields

org.openrewrite.java.search.FindFields
Find uses of a field.
Recipe source
​GitHub, Issue Tracker, Maven Central​
groupId: org.openrewrite
artifactId: rewrite-java
version: 8.9.5
Options
Type
Name
Description
String
fullyQualifiedTypeName
A fully-qualified Java type name, that is used to find matching fields.
Boolean
matchInherited
Optional. When enabled, find types that inherit from a deprecated type.
String
fieldName
The name of a field on the 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.FindFieldsExample. 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.FindFieldsExample
displayName: Find fields example
recipeList:
  - org.openrewrite.java.search.FindFields:
      fullyQualifiedTypeName: com.fasterxml.jackson.core.json.JsonWriteFeature
      matchInherited: null
      fieldName: QUOTE_FIELD_NAMES
Now that com.yourorg.FindFieldsExample has been defined activate it in your build file:
Gradle
Maven
Moderne CLI
1.Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("6.5.6")
}
​
rewrite {
    activeRecipe("com.yourorg.FindFieldsExample")
}
​
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.13.0</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.FindFieldsExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>
2.Run mvn rewrite:run to run the recipe.
You will need to have configured the Moderne CLI on your machine before you can run the following command.
shell
mod run . --recipe FindFields
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, Tyler Van Gorder, Sam Snyder​

Type	Name	Description
`String`	fullyQualifiedTypeName	A fully-qualified Java type name, that is used to find matching fields.
`Boolean`	matchInherited	Optional. When enabled, find types that inherit from a deprecated type.
`String`	fieldName	The name of a field on the type.

Find empty classes

Find fields of type

Last modified 12d ago