Skip to main content

Replace a deprecated AWT method

org.openrewrite.java.migrate.awt.ReplaceDeprecatedAwtMethod

Replace calls to an AWT method deprecated since JDK 1.1 with calls to the method that replaced it. Declarations and super calls are left alone: the replacements delegate back to the deprecated methods, so a rewritten super call would reach overrides it used to bypass.

Recipe source​

GitHub: ReplaceDeprecatedAwtMethod.java, Issue Tracker, Code Genome Project

This recipe is available under the Moderne Source Available License. Moderne customers can download precompiled artifacts from The Code Genome Project. For non-commercial use you can build the artifact from source locally.

Options​

TypeNameDescriptionExample
StringmethodPatternA method pattern matching the deprecated method; overrides of it are matched as well.java.awt.Component show()
StringnewMethodNameThe name of the method that replaces the deprecated one.setVisible
BooleanbooleanArgumentOptional. A boolean literal to pass as an extra, last argument to the new method.true

Used by​

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

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.ReplaceDeprecatedAwtMethodExample. 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.ReplaceDeprecatedAwtMethodExample
displayName: Replace a deprecated AWT method example
recipeList:
  - org.openrewrite.java.migrate.awt.ReplaceDeprecatedAwtMethod:
      methodPattern: java.awt.Component show()
      newMethodName: setVisible
      booleanArgument: true

Now that com.yourorg.ReplaceDeprecatedAwtMethodExample has been defined, activate it and take a dependency on org.openrewrite.recipe:rewrite-migrate-java:3.46.0 in your build file:

OpenRewrite artifacts, including the Maven and Gradle plugins themselves, are distributed through the Code Genome Project repository (https://artifacts.codegenomeproject.org/maven), which requires authentication. Sign in to the Code Genome Project to create a download token; your build authenticates with the email or username you signed in with, plus that token as the password. See the quickstart guide for details.

  1. Put your Code Genome Project credentials in ~/.gradle/gradle.properties, so that they are not committed alongside your build:
    ~/.gradle/gradle.properties
    codeGenomeUsername=you@example.com
    codeGenomeToken=your-download-token
  2. Add the Code Genome Project repository to your settings.gradle file, so that the plugin itself can be resolved:
    settings.gradle
    pluginManagement {
        repositories {
            maven {
                url = "https://artifacts.codegenomeproject.org/maven"
                credentials {
                    username = providers.gradleProperty("codeGenomeUsername").get()
                    password = providers.gradleProperty("codeGenomeToken").get()
                }
            }
            // Keep the portal for any other plugins your build applies
            gradlePluginPortal()
        }
    }
  3. Add the following to your build.gradle file:
    build.gradle
    plugins {
        id("org.openrewrite.rewrite") version("latest.release")
    }

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

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

    dependencies {
        rewrite("org.openrewrite.recipe:rewrite-migrate-java:3.46.0")
    }
  4. 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.