Skip to main content

Change annotation attribute name

org.openrewrite.java.ChangeAnnotationAttributeName

Some annotations accept arguments. This recipe renames an existing attribute.

Recipe source​

GitHub, 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
StringoldAttributeNameThe name of attribute to change.timeout
StringnewAttributeNameThe new attribute name to use.waitFor

Example​

Parameters​
ParameterValue
annotationTypeorg.junit.jupiter.api.Tag
oldAttributeNamevalue
newAttributeNamenewValue
Before​
package sample

import org.junit.jupiter.api.Tag
import org.junit.jupiter.api.Tags

class SampleTest {

    @Tags(
        value = [
            Tag(value = "Sample01"),
            Tag(value = "Sample02"),
        ]
    )
    fun run() {
    }
}
After​
package sample

import org.junit.jupiter.api.Tag
import org.junit.jupiter.api.Tags

class SampleTest {

    @Tags(
        value = [
            Tag(newValue = "Sample01"),
            Tag(newValue = "Sample02"),
        ]
    )
    fun run() {
    }
}

Usage​

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly (unless you are running them via the Moderne CLI). 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.ChangeAnnotationAttributeNameExample. 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.ChangeAnnotationAttributeNameExample
displayName: Change annotation attribute name example
recipeList:
  - org.openrewrite.java.ChangeAnnotationAttributeName:
      annotationType: org.junit.Test
      oldAttributeName: timeout
      newAttributeName: waitFor

Now that com.yourorg.ChangeAnnotationAttributeNameExample has been defined, activate it in your build file:

  1. Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("7.5.0")
}

rewrite {
    activeRecipe("com.yourorg.ChangeAnnotationAttributeNameExample")
    setExportDatatables(true)
}

repositories {
    mavenCentral()
}
  1. Run gradle rewriteRun to run the recipe.

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.

Contributors​

Tim te Beek, Jonathan Schnéider, Tobias Lidskog, Knut Wannheden