Links

Change method access level

org.openrewrite.java.ChangeMethodAccessLevel
Change the access level (public, protected, private, package private) of a method.

Recipe source

  • groupId: org.openrewrite
  • artifactId: rewrite-java
  • version: 8.17.1

Options

Type
Name
Description
Example
String
methodPattern
A method pattern that is used to find matching method declarations/invocations.
org.mockito.Matchers anyVararg()
String
newAccessLevel
New method access level to apply to the method. Valid options: private, protected, package, public
public
Boolean
matchOverrides
Optional. When enabled, find methods that are overrides of the method pattern.

Usage

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly. 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.ChangeMethodAccessLevelExample. 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.ChangeMethodAccessLevelExample
displayName: Change method access level example
recipeList:
- org.openrewrite.java.ChangeMethodAccessLevel:
methodPattern: org.mockito.Matchers anyVararg()
newAccessLevel: public
Now that com.yourorg.ChangeMethodAccessLevelExample has been defined activate it in your build file:
Gradle
Maven
Moderne CLI
  1. 1.
    Add the following to your build.gradle file:
build.gradle
plugins {
id("org.openrewrite.rewrite") version("6.8.4")
}
rewrite {
activeRecipe("com.yourorg.ChangeMethodAccessLevelExample")
}
repositories {
mavenCentral()
}
  1. 2.
    Run gradle rewriteRun to run the recipe.
  1. 1.
    Add the following to your pom.xml file:
pom.xml
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>5.23.1</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.ChangeMethodAccessLevelExample</recipe>
</activeRecipes>
</configuration>
</plugin>
</plugins>
</build>
</project>
  1. 2.
    Run mvn rewrite:run to run the recipe.
You will need to have configured the Moderne CLI on your machine before you can run the following command.
shell
mod run . --recipe ChangeMethodAccessLevelExample

See how this recipe works across multiple open-source repositories

Moderne Link Image
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.

Contributors