Design Partners
Add or update annotation attribute
** org.openrewrite.java.AddOrUpdateAnnotationAttribute** _Some annotations accept arguments. This recipe sets an existing argument to the specified value, or adds the argument if it is not already set. _

Source

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

Options

Type
Name
Description
String
annotationType
The fully qualified name of the annotation.
String
attributeName
Optional. The name of attribute to change. If omitted defaults to 'value'.
String
attributeValue
The value to set the attribute to.
Boolean
addOnly
When set to true will not change existing annotation attribute values.

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.AddOrUpdateAnnotationAttributeExample. 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.AddOrUpdateAnnotationAttributeExample
displayName: Add or update annotation attribute example
recipeList:
- org.openrewrite.java.AddOrUpdateAnnotationAttribute:
annotationType: org.junit.Test
attributeName: timeout
attributeValue: 500
addOnly: null
Now that com.yourorg.AddOrUpdateAnnotationAttributeExample has been defined activate it in your build file:
Gradle
Maven
build.gradle
plugins {
id("org.openrewrite.rewrite") version("5.29.0")
}
rewrite {
activeRecipe("com.yourorg.AddOrUpdateAnnotationAttributeExample")
}
repositories {
mavenCentral()
}
pom.xml
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>4.34.0</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.AddOrUpdateAnnotationAttributeExample</recipe>
</activeRecipes>
</configuration>
</plugin>
</plugins>
</build>
</project>
Recipes can also be activated directly from the commandline by adding the argument -Drewrite.activeRecipes=com.yourorg.AddOrUpdateAnnotationAttributeExample
Export as PDF
Copy link
On this page
Source
Options
Usage