Change static field access to static method access
org.openrewrite.java.ChangeStaticFieldToMethod
Migrate accesses to a static field to invocations of a static method.
Recipe source
GitHub, Issue Tracker, Maven Central
- groupId: org.openrewrite
- artifactId: rewrite-java
- version: 8.38.0
Options
Type | Name | Description | Example |
---|---|---|---|
String | oldClassName | The fully qualified name of the class containing the field to replace. | java.util.Collections |
String | oldFieldName | The simple name of the static field to replace. | EMPTY_LIST |
String | newClassName | Optional. The fully qualified name of the class containing the method to use. Leave empty to keep the same class. | java.util.List |
String | newTarget | Optional. An optional method target that can be used to specify a static field within the new class. | OK_RESPONSE |
String | newMethodName | The simple name of the method to use. The method must be static and have no arguments. | of |
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.ChangeStaticFieldToMethodExample
.
Here's how you can define and customize such a recipe within your rewrite.yml:
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.ChangeStaticFieldToMethodExample
displayName: Change static field access to static method access example
recipeList:
- org.openrewrite.java.ChangeStaticFieldToMethod:
oldClassName: java.util.Collections
oldFieldName: EMPTY_LIST
newClassName: java.util.List
newTarget: OK_RESPONSE
newMethodName: of
Now that com.yourorg.ChangeStaticFieldToMethodExample
has been defined, activate it in your build file:
- Gradle
- Maven
- Moderne CLI
- Add the following to your
build.gradle
file:
plugins {
id("org.openrewrite.rewrite") version("6.26.0")
}
rewrite {
activeRecipe("com.yourorg.ChangeStaticFieldToMethodExample")
exportDatatables = true
}
repositories {
mavenCentral()
}
- Run
gradle rewriteRun
to run the recipe.
- Add the following to your
pom.xml
file:
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>5.43.0</version>
<configuration>
<exportDatatables>true</exportDatatables>
<activeRecipes>
<recipe>com.yourorg.ChangeStaticFieldToMethodExample</recipe>
</activeRecipes>
</configuration>
</plugin>
</plugins>
</build>
</project>
- 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.
mod run . --recipe ChangeStaticFieldToMethodExample
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.
Data Tables
Source files that had results
org.openrewrite.table.SourcesFileResults
Source files that were modified by the recipe run.
Column Name | Description |
---|---|
Source path before the run | The source path of the file before the run. null when a source file was created during the run. |
Source path after the run | A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run. |
Parent of the recipe that made changes | In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all. |
Recipe that made changes | The specific recipe that made a change. |
Estimated time saving | An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds. |
Cycle | The recipe cycle in which the change was made. |
Source files that errored on a recipe
org.openrewrite.table.SourcesFileErrors
The details of all errors produced by a recipe run.
Column Name | Description |
---|---|
Source path | The file that failed to parse. |
Recipe that made changes | The specific recipe that made a change. |
Stack trace | The stack trace of the failure. |
Recipe performance
org.openrewrite.table.RecipeRunStats
Statistics used in analyzing the performance of recipes.
Column Name | Description |
---|---|
The recipe | The recipe whose stats are being measured both individually and cumulatively. |
Source file count | The number of source files the recipe ran over. |
Source file changed count | The number of source files which were changed in the recipe run. Includes files created, deleted, and edited. |
Cumulative scanning time | The total time spent across the scanning phase of this recipe. |
99th percentile scanning time | 99 out of 100 scans completed in this amount of time. |
Max scanning time | The max time scanning any one source file. |
Cumulative edit time | The total time spent across the editing phase of this recipe. |
99th percentile edit time | 99 out of 100 edits completed in this amount of time. |
Max edit time | The max time editing any one source file. |
Contributors
Christian Semrau, Jonathan Schnéider, Tyler Van Gorder, Samuel Cox, traceyyoshima, Sam Snyder, Tim te Beek, Knut Wannheden, Thomas Zub, Aaron Gershman