org.openrewrite.java.trait.MethodAccess Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rewrite-java Show documentation
Eliminate tech-debt. Automatically.
There is a newer version: 8.40.2
/*
 * Copyright 2024 the original author or authors.
 * 
 * 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.trait;

import lombok.RequiredArgsConstructor;
import lombok.Value;
import org.jspecify.annotations.Nullable;
import org.openrewrite.Cursor;
import org.openrewrite.Incubating;
import org.openrewrite.Tree;
import org.openrewrite.TreeVisitor;
import org.openrewrite.java.JavaVisitor;
import org.openrewrite.java.MethodMatcher;
import org.openrewrite.java.tree.Expression;
import org.openrewrite.java.tree.J;
import org.openrewrite.java.tree.JavaType;
import org.openrewrite.java.tree.MethodCall;
import org.openrewrite.trait.SimpleTraitMatcher;
import org.openrewrite.trait.Trait;
import org.openrewrite.trait.VisitFunction2;

import java.util.function.Predicate;

@Incubating(since = "8.30.0")
@Value
public class MethodAccess implements Trait {
    Cursor cursor;

    @RequiredArgsConstructor
    public static class Matcher extends SimpleTraitMatcher {
        @Nullable
        private final MethodMatcher methodMatcher;
        private Predicate<@Nullable JavaType> returnsTest = m -> true;

        public Matcher() {
            methodMatcher = null;
        }

        public Matcher(String methodPattern) {
            this(new MethodMatcher(methodPattern));
        }

        public Matcher returns(Predicate<@Nullable JavaType> returnsTest) {
            this.returnsTest = returnsTest;
            return this;
        }

        @Override
        public 
 TreeVisitor asVisitor(VisitFunction2 visitor) {
            return new JavaVisitor() {
                @Override
                public J visitMethodInvocation(J.MethodInvocation method, P p) {
                    MethodAccess methodAccess = test(getCursor());
                    return methodAccess != null ?
                            (J) visitor.visit(methodAccess, p) :
                            super.visitMethodInvocation(method, p);
                }

                @Override
                public J visitNewClass(J.NewClass newClass, P p) {
                    MethodAccess methodAccess = test(getCursor());
                    return methodAccess != null ?
                            (J) visitor.visit(methodAccess, p) :
                            super.visitNewClass(newClass, p);
                }

                @Override
                public J visitMemberReference(J.MemberReference memberRef, P p) {
                    MethodAccess methodAccess = test(getCursor());
                    return methodAccess != null ?
                            (J) visitor.visit(methodAccess, p) :
                            super.visitMemberReference(memberRef, p);
                }
            };
        }

        @Override
        protected @Nullable MethodAccess test(Cursor cursor) {
            Object value = cursor.getValue();
            JavaType.Method methodType = ((MethodCall) value).getMethodType();
            JavaType returnType = methodType == null ? null : methodType.getReturnType();
            return returnsTest.test(returnType) && (methodMatcher == null || methodMatcher.matches((Expression) value)) ?
                    new MethodAccess(cursor) :
                    null;
        }
    }
}