Skip to main content

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.

Recipe source​

GitHub: AddOrUpdateAnnotationAttribute.java, Issue Tracker, Maven Central

This recipe is available under the Apache License Version 2.0.

Options​

TypeNameDescriptionExample
StringannotationTypeThe fully qualified name of the annotation.org.junit.Test
StringattributeNameOptional. The name of attribute to change. If omitted defaults to 'value'.timeout
StringattributeValueOptional. The value to set the attribute to. If the attribute is an array, provide values separated by comma to add multiple attributes at once. Set to null to remove the attribute.500
StringoldAttributeValueOptional. The current value of the attribute, this can be used to filter where the change is applied. Set to null for wildcard behavior.400
BooleanaddOnlyOptional. If true, disables upgrading existing annotation attribute values, thus the recipe will only add the attribute if it does not already exist. If omitted or false, the recipe adds the attribute if missing or updates its value if present.
BooleanappendArrayOptional. If the attribute is an array and attribute is present, setting this option to true will append the value(s). Duplicate values will not be added. If omitted or false, the recipe will replace the existing value(s) with the new value(s).

Used by​

This recipe is used as part of the following composite recipes:

Example​

Parameters​
ParameterValue
annotationTypeorg.example.Foo
attributeNamenull
attributeValuehello
oldAttributeValuenull
addOnlynull
appendArraynull
Before​
import org.example.Foo;

@Foo
public class A {
}
After​
import org.example.Foo;

@Foo("hello")
public class A {
}
Unchanged​
package org.example;
public @interface Foo {
    String value() default "";
}

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.AddOrUpdateAnnotationAttributeExample
displayName: Add or update annotation attribute example
recipeList:
  - org.openrewrite.java.AddOrUpdateAnnotationAttribute:
      annotationType: org.junit.Test
      attributeName: timeout
      attributeValue: 500
      oldAttributeValue: 400

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

shell
mod run . --recipe AddOrUpdateAnnotationAttribute --recipe-option "annotationType=org.junit.Test" --recipe-option "attributeName=timeout" --recipe-option "attributeValue=500" --recipe-option "oldAttributeValue=400"

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

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

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​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA 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 changesIn 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 changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.