Replace Annotation
org.openrewrite.java.ReplaceAnnotation
Replace an Annotation with another one if the annotation pattern matches. Only fixed parameters can be set in the replacement.
Recipe source
GitHub, Issue Tracker, Maven Central
groupId: org.openrewrite
artifactId: rewrite-java
version: 8.28.1
Options
Type | Name | Description | Example |
---|---|---|---|
| annotationPatternToReplace | An annotation matcher, expressed as a method pattern to replace. |
|
| annotationTemplateToInsert | An annotation template to add instead of original one, will be parsed with |
|
| classpathResourceName | Optional. If the annotation's type is defined by a jar within the META-INF/rewrite/classpath directory provide its name here so that it can be loaded. When this parameter is not passed the runtime classpath of the recipe is provided to the parser producing the new annotation. This is necessary when the annotation is not on the runtime classpath of the recipe and isn't in the Java standard library. |
|
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.ReplaceAnnotationExample
. Here's how you can define and customize such a recipe within your rewrite.yml:
Now that com.yourorg.ReplaceAnnotationExample
has been defined activate it in your build file:
Add the following to your
build.gradle
file:
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
Merlin Bögershausen, Sam Snyder, Tim te Beek, Knut Wannheden
Last updated