Skip to main content

Find uses of deprecated methods

org.openrewrite.java.search.FindDeprecatedMethods

Find uses of deprecated methods in any API.

Recipe source​

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

This recipe is available under the Apache License Version 2.0.

Options​

TypeNameDescriptionExample
StringmethodPatternOptional. A method pattern is used to find matching method invocations. For example, to find all method invocations in the Guava library, use the pattern: com.google.common..*#*(..).

The pattern format is <PACKAGE>#<METHOD_NAME>(<ARGS>).

..* includes all subpackages of com.google.common.
*(..) matches any method name with any number of arguments.

For more specific queries, like Guava's ImmutableMap, use com.google.common.collect.ImmutableMap#*(..) to narrow down the results.		java.util.List add(..)
BooleanignoreDeprecatedScopesOptional. When set to true deprecated methods used within deprecated methods or classes will be ignored.

Used by​

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

Example​

Parameters​
ParameterValue
methodPatternnull
ignoreDeprecatedScopesnull
Before​
class Test {
    @Deprecated
    void test(int n) {
        if(n == 1) {
            test(n + 1);
        }
    }
}
After​
class Test {
    @Deprecated
    void test(int n) {
        if(n == 1) {
            /*~~>*/test(n + 1);
        }
    }
}

Usage​

This recipe has no required configuration parameters and comes from a rewrite core library. It can be activated directly without adding any dependencies.

OpenRewrite artifacts 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, then in the snippets below replace USERNAME with the email or username you signed in with and TOKEN with that token. See the quickstart guide for details.

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

    rewrite {
        activeRecipe("org.openrewrite.java.search.FindDeprecatedMethods")
        setExportDatatables(true)
    }

    repositories {
        mavenCentral()
        maven {
            url = "https://artifacts.codegenomeproject.org/maven"
            credentials {
                username = "USERNAME"
                password = "TOKEN"
            }
        }
    }
  2. 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​

Method calls​

org.openrewrite.java.table.MethodCalls

The text of matching method invocations.

Column NameDescription
Source fileThe source file that the method call occurred in.
Method callThe text of the method call.
Class nameThe class name of the method call.
Method nameThe method name of the method call.
Argument typesThe argument types of the method call.