Skip to content

recipe: replace Arrays#asList() by List#of() #466

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
/*
* Copyright 2025 the original author or authors.
* <p>
* Licensed under the Moderne Source Available License (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* <p>
* https://docs.moderne.io/licensing/moderne-source-available-license
* <p>
* 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.staticanalysis;

import java.time.Duration;

import org.openrewrite.ExecutionContext;
import org.openrewrite.Preconditions;
import org.openrewrite.Recipe;
import org.openrewrite.TreeVisitor;
import org.openrewrite.java.JavaTemplate;
import org.openrewrite.java.JavaVisitor;
import org.openrewrite.java.MethodMatcher;
import org.openrewrite.java.search.UsesMethod;
import org.openrewrite.java.tree.J;

public class ReplaceArraysAsListWithListOf extends Recipe {

private static final MethodMatcher ARRAYS_AS_LIST = new MethodMatcher("java.util.Arrays asList(..)");

@Override
public String getDisplayName() {
return "Replace Arrays.asList() with List.of()";
}

@Override
public String getDescription() {
return "Replace `Arrays.asList()` with `List.of()` when the number of arguments is less than 11.";
}

@Override
public Duration getEstimatedEffortPerOccurrence() {
return Duration.ofMinutes(1);
}

@Override
public TreeVisitor<?, ExecutionContext> getVisitor() {
return Preconditions.check(new UsesMethod<>(ARRAYS_AS_LIST), new JavaVisitor<ExecutionContext>() {

private final JavaTemplate template = JavaTemplate.builder("List.of(#{any(java.lang.Object[])})")
.imports("java.util.List")
.build();

@Override
public J visitMethodInvocation(J.MethodInvocation method, ExecutionContext ctx) {
J.MethodInvocation result = (J.MethodInvocation) super.visitMethodInvocation(method, ctx);
if (ARRAYS_AS_LIST.matches(method) && method.getArguments().size() < 11) {
result = template.apply(updateCursor(result), result.getCoordinates().replace(),
result.getArguments().toArray());
maybeAddImport("java.util.List");
maybeRemoveImport("java.util.Arrays");
}
return result;
}
});
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
/*
* Copyright 2024 the original author or authors.
* <p>
* Licensed under the Moderne Source Available License (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* <p>
* https://docs.moderne.io/licensing/moderne-source-available-license
* <p>
* 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.staticanalysis;

import org.junit.jupiter.api.Test;
import org.openrewrite.DocumentExample;
import org.openrewrite.test.RecipeSpec;
import org.openrewrite.test.RewriteTest;

import static org.openrewrite.java.Assertions.java;

@SuppressWarnings("java:S2699")
class ReplaceArraysAsListWithListOfTest implements RewriteTest {

@Override
public void defaults(RecipeSpec spec) {
spec.recipe(new ReplaceArraysAsListWithListOf());
}

@DocumentExample
@Test
void replaceWithSingleArgument() {
rewriteRun(
//language=java
java(
"""
import java.util.Arrays;

class A {
void foo() {
Arrays.asList("A");
}
}
""",
"""
import java.util.List;

class A {
void foo() {
List.of("A");
}
}
"""
)
);
}

@Test
void replaceWith10Arguments() {
rewriteRun(
//language=java
java(
"""
import java.util.Arrays;

class A {
void foo() {
Arrays.asList(1, 2, 3, 4, 5, 6, 7, 8, 9, 10);
}
}
""",
"""
import java.util.List;

class A {
void foo() {
List.of(1, 2, 3, 4, 5, 6, 7, 8, 9, 10);
}
}
"""
)
);
}

@Test
void doNotReplaceWith11Arguments() {
rewriteRun(
//language=java
java(
"""
import java.util.Arrays;

class A {
void foo() {
Arrays.asList(1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11);
}
}
"""
)
);
}
}
Loading