+ * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + *
+ * https://www.apache.org/licenses/LICENSE-2.0 + *
+ * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.openrewrite.java.spring; + +import lombok.EqualsAndHashCode; +import lombok.RequiredArgsConstructor; +import lombok.Value; +import org.openrewrite.*; +import org.openrewrite.java.JavaIsoVisitor; +import org.openrewrite.java.MethodMatcher; +import org.openrewrite.java.search.DeclaresMethod; +import org.openrewrite.java.service.ImportService; +import org.openrewrite.java.tree.*; +import org.openrewrite.marker.Markers; + +import java.util.ArrayList; +import java.util.List; + +import static java.util.Collections.emptyList; +import static java.util.Collections.singletonList; +import static org.openrewrite.Tree.randomId; + +/** + * A recipe to change parameter type for a method declaration. + *
+ * NOTE: This recipe is usually used for initial modification of parameter changes.
+ * After modifying method parameters using this recipe, you may also need to modify
+ * the method definition as needed to avoid compilation errors.
+ */
+@Value
+@EqualsAndHashCode(callSuper = false)
+public class ChangeMethodParameter extends Recipe {
+
+ /**
+ * A method pattern that is used to find matching method declarations.
+ * See {@link MethodMatcher} for details on the expression's syntax.
+ */
+ @Option(displayName = "Method pattern",
+ description = "A method pattern that is used to find the method declarations to modify.",
+ example = "com.yourorg.A foo(int, int)")
+ String methodPattern;
+
+ @Option(displayName = "Parameter type",
+ description = "The new type of the parameter that gets updated.",
+ example = "java.lang.String")
+ String parameterType;
+
+ @Option(displayName = "Parameter index",
+ description = "A zero-based index that indicates the position at which the parameter will be added.",
+ example = "0")
+ Integer parameterIndex;
+
+ @Override
+ public String getInstanceNameSuffix() {
+ return String.format("`%s` in methods `%s`", parameterType, methodPattern);
+ }
+
+ @Override
+ public String getDisplayName() {
+ return "Change parameter type for a method declaration";
+ }
+
+ @Override
+ public String getDescription() {
+ return "Change parameter type for a method declaration, identified by a method pattern.";
+ }
+
+ @Override
+ public TreeVisitor getVisitor() {
+ MethodMatcher methodMatcher = new MethodMatcher(methodPattern, true);
+ return Preconditions.check(new DeclaresMethod<>(methodMatcher), new ChangeMethodArgumentVisitor(methodMatcher));
+ }
+
+ @RequiredArgsConstructor
+ private class ChangeMethodArgumentVisitor extends JavaIsoVisitor
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.openrewrite.java.spring;
+
+import org.junit.jupiter.api.Test;
+import org.openrewrite.DocumentExample;
+import org.openrewrite.test.RewriteTest;
+
+import static org.openrewrite.java.Assertions.java;
+
+class ChangeMethodParameterTest implements RewriteTest {
+
+ @DocumentExample
+ @Test
+ void primitive() {
+ rewriteRun(
+ spec -> spec.recipe(new ChangeMethodParameter("foo.Foo#bar(..)", "long", 0)),
+ //language=java
+ java(
+ """
+ package foo;
+ class Foo {
+ void bar(int i) {
+ }
+ }
+ """,
+ """
+ package foo;
+ class Foo {
+ void bar(long i) {
+ }
+ }
+ """
+ )
+ );
+ }
+
+ @Test
+ void indexLargeThanZero() {
+ rewriteRun(
+ spec -> spec.recipe(new ChangeMethodParameter("foo.Foo#bar(..)", "long", 1)),
+ //language=java
+ java(
+ """
+ package foo;
+ class Foo {
+ void bar(int i, int j) {
+ }
+ }
+ """,
+ """
+ package foo;
+ class Foo {
+ void bar(int i, long j) {
+ }
+ }
+ """
+ )
+ );
+ }
+
+ @Test
+ void sameType() {
+ rewriteRun(
+ spec -> spec.recipe(new ChangeMethodParameter("foo.Foo#bar(..)", "int", 0)),
+ //language=java
+ java(
+ """
+ package foo;
+ class Foo {
+ void bar(int i) {
+ }
+ }
+ """
+ )
+ );
+ }
+
+ @Test
+ void notExistsIndex() {
+ rewriteRun(
+ spec -> spec.recipe(new ChangeMethodParameter("foo.Foo#bar(..)", "int", 1)),
+ //language=java
+ java(
+ """
+ package foo;
+ class Foo {
+ void bar(int i) {
+ }
+ }
+ """
+ )
+ );
+ }
+
+ @Test
+ void methodNotMatch() {
+ rewriteRun(
+ spec -> spec.recipe(new ChangeMethodParameter("foo.Foo#bar(..)", "long", 0)),
+ //language=java
+ java(
+ """
+ package foo;
+ class Foo {
+ void bar(int i) {
+ }
+ }
+ """,
+ """
+ package foo;
+ class Foo {
+ void bar(long i) {
+ }
+ }
+ """
+ )
+ );
+ }
+
+ @Test
+ void typePattern() {
+ rewriteRun(
+ spec -> spec.recipe(new ChangeMethodParameter("*..*#bar(..)", "long", 0)),
+ //language=java
+ java(
+ """
+ package foo;
+ class Foo {
+ void bar(int i) {
+ }
+ }
+ """,
+ """
+ package foo;
+ class Foo {
+ void bar(long i) {
+ }
+ }
+ """
+ )
+ );
+ }
+
+ @Test
+ void primitiveArray() {
+ rewriteRun(
+ spec -> spec.recipe(new ChangeMethodParameter("foo.Foo#bar(..)", "int[]", 0)),
+ //language=java
+ java(
+ """
+ package foo;
+ class Foo {
+ void bar(int i) {
+ }
+ }
+ """,
+ """
+ package foo;
+ class Foo {
+ void bar(int[] i) {
+ }
+ }
+ """
+ )
+ );
+ }
+
+ @Test
+ void parameterized() {
+ rewriteRun(
+ spec -> spec.recipe(new ChangeMethodParameter("foo.Foo#bar(..)", "java.util.List
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.openrewrite.java.spring.batch;
+
+import org.junit.jupiter.api.Test;
+import org.openrewrite.DocumentExample;
+import org.openrewrite.InMemoryExecutionContext;
+import org.openrewrite.java.JavaParser;
+import org.openrewrite.test.RecipeSpec;
+import org.openrewrite.test.RewriteTest;
+
+import static org.openrewrite.java.Assertions.java;
+
+class UpgradeSkipPolicyParameterTypeTest implements RewriteTest {
+ @Override
+ public void defaults(RecipeSpec spec) {
+ spec
+ .recipeFromResource("/META-INF/rewrite/spring-batch-5.0.yml", "org.openrewrite.java.spring.batch.UpgradeSkipPolicyParameterType")
+ .parser(JavaParser.fromJavaVersion().classpathFromResources(new InMemoryExecutionContext(),
+ "spring-batch-core-4.3.+",
+ "spring-batch-infrastructure-4.3.+",
+ "spring-beans-4.3.30.RELEASE",
+ "spring-batch",
+ "spring-boot",
+ "spring-core",
+ "spring-context"
+ ));
+ }
+
+ @DocumentExample
+ @Test
+ void replaceParameter() {
+ // language=java
+ rewriteRun(
+ java(
+ """
+ import org.springframework.batch.core.step.skip.SkipLimitExceededException;
+ import org.springframework.batch.core.step.skip.SkipPolicy;
+
+ public class MySkipPolicy implements SkipPolicy {
+ @Override
+ public boolean shouldSkip(Throwable throwable, int skipCount) {
+ return true;
+ }
+ }
+ """,
+ """
+ import org.springframework.batch.core.step.skip.SkipLimitExceededException;
+ import org.springframework.batch.core.step.skip.SkipPolicy;
+
+ public class MySkipPolicy implements SkipPolicy {
+ @Override
+ public boolean shouldSkip(Throwable throwable, long skipCount) {
+ return true;
+ }
+ }
+ """
+ )
+ );
+ }
+}