Find fields of type

org.openrewrite.java.search.FindFieldsOfType

Finds declared fields matching a particular class 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 Java type name, that is used to find matching fields.

org.slf4j.api.Logger

Boolean

matchInherited

Optional. When enabled, find types that inherit from a deprecated 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.FindFieldsOfTypeExample. 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.FindFieldsOfTypeExample
displayName: Find fields of type example
recipeList:
  - org.openrewrite.java.search.FindFieldsOfType:
      fullyQualifiedTypeName: org.slf4j.api.Logger

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

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, Tyler Van Gorder, Sam Snyder, Knut Wannheden, Tim te Beek

Last updated