findfields.md

Find fields

org.openrewrite.java.search.FindFields

Find uses of a field.

Source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite
• artifactId: rewrite-java
• version: 8.1.3

Options

Type	Name	Description
String	fullyQualifiedTypeName	A fully-qualified Java type name, that is used to find matching fields.
String	fieldName	The name of a field on the type.

Example

Parameters

Parameter	Value
fullyQualifiedTypeName	java.nio.charset.StandardCharsets
fieldName	UTF_8

{% tabs %} {% tab title="Test.java" %}

Before

{% code title="Test.java" %}

class Test {
    Object o = java.nio.charset.StandardCharsets.UTF_8;
}

{% endcode %}

After

{% code title="Test.java" %}

class Test {
    Object o = /*~~>*/java.nio.charset.StandardCharsets.UTF_8;
}

{% endcode %}

{% endtab %} {% tab title="Diff" %} {% code %}

--- Test.java
+++ Test.java
@@ -2,1 +2,1 @@
class Test {
-   Object o = java.nio.charset.StandardCharsets.UTF_8;
+   Object o = /*~~>*/java.nio.charset.StandardCharsets.UTF_8;
}

{% endcode %} {% endtab %} {% endtabs %}

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:

{% code title="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
      fieldName: QUOTE_FIELD_NAMES

{% endcode %}

Now that com.yourorg.FindFieldsExample has been defined activate it in your build file: {% tabs %} {% tab title="Gradle" %} {% code title="build.gradle" %}

plugins {
    id("org.openrewrite.rewrite") version("6.1.4")
}

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

repositories {
    mavenCentral()
}

{% endcode %} {% endtab %} {% tab title="Maven" %} {% code title="pom.xml" %}

<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.2.4</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.FindFieldsExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

{% endcode %} {% endtab %} {% endtabs %}

Contributors

• Jonathan Schneider
• Greg Adams
• Tyler Van Gorder
• Sam Snyder

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.