← All recipes
Open source

Change annotation attribute name

Recipe IDorg.openrewrite.java.ChangeAnnotationAttributeNameArtifactorg.openrewrite:rewrite-java

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

Single recipeApache 2.0

Add to your build

Get a download tokenSign in with GitHub or Google, and your token replaces YOUR_DOWNLOAD_TOKEN below. Free for open source recipes like this one.

~/.gradle/gradle.properties

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

build.gradle.kts

plugins {
    id("org.openrewrite.rewrite") version("latest.release")
}

rewrite {
    activeRecipe("org.openrewrite.java.ChangeAnnotationAttributeName")
}

repositories {
    mavenCentral()
    maven {
        url = uri("https://artifacts.codegenomeproject.org/maven")
        credentials {
            username = providers.gradleProperty("codeGenomeUsername").get()
            password = providers.gradleProperty("codeGenomeToken").get()
        }
    }
}

dependencies {
    rewrite("org.openrewrite:rewrite-java:8.92.8")
}

Then run

./gradlew rewriteRun

This recipe has required options, which a build sets in a rewrite.yml recipe that you activate instead.

Usage

You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.java.ChangeAnnotationAttributeName --recipe-option "annotationType=org.junit.Test" --recipe-option "oldAttributeName=timeout" --recipe-option "newAttributeName=waitFor"

If the recipe isn’t available locally, install it with:

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

Options

NameTypeDescription
annotationTyperequiredStringThe fully qualified name of the annotation.
e.g. org.junit.Test
oldAttributeNamerequiredStringThe name of attribute to change.
e.g. timeout
newAttributeNamerequiredStringThe new attribute name to use.
e.g. waitFor

Data tables

Structured output this recipe can produce.

  • Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
  • Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
  • Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
  • Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats