Skip to main content

Find fields of type

org.openrewrite.java.search.FindFieldsOfType

Finds declared fields matching a particular class name.

Recipe source​

GitHub: FindFieldsOfType.java, Issue Tracker, Maven Central

This recipe is available under the Apache License Version 2.0.

Options​

TypeNameDescriptionExample
StringfullyQualifiedTypeNameA fully-qualified Java type name, that is used to find matching fields.org.slf4j.api.Logger
BooleanmatchInheritedOptional. When enabled, find types that inherit from a deprecated type.

Example​

Parameters​
ParameterValue
fullyQualifiedTypeNamejava.lang.String
matchInheritednull
Before​
import java.util.*;
public class A {
   private String[] s;
}
After​
import java.util.*;
public class A {
   /*~~>*/private String[] s;
}

Usage​

This recipe has required configuration parameters and can only be run by users of Moderne. To run this recipe, you will need to provide the Moderne CLI run command with the required options. Or, if you'd like to create a declarative recipe, please see the below example of a rewrite.yml file:

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

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell
mod run . --recipe FindFieldsOfType --recipe-option "fullyQualifiedTypeName=org.slf4j.api.Logger"

If the recipe is not available locally, then you can install it using:

mod config recipes jar install org.openrewrite:rewrite-java:8.74.1

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​

Fields of type uses​

org.openrewrite.java.table.FieldsOfTypeUses

Information about fields that match a specific type.

Column NameDescription
Source fileThe source file that contains the field declaration.
Field nameThe name of the field.
Field typeThe declared type of the field.
Concrete field typeThe concrete type of the field, which may be a subtype of a searched type.
Field modifiersThe modifiers of the field.
Field declarationThe source code of the field declaration.