com.palantir.baseline.errorprone.IncubatingMethod Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of baseline-error-prone Show documentation

A Gradle plugin for applying Baseline-recommended build and IDE settings

There is a newer version: 6.11.0

/*
 * (c) Copyright 2020 Palantir Technologies Inc. All rights reserved.
 *
 * 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
 *
 *     http://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 com.palantir.baseline.errorprone;

import com.google.auto.service.AutoService;
import com.google.errorprone.BugPattern;
import com.google.errorprone.VisitorState;
import com.google.errorprone.bugpatterns.BugChecker;
import com.google.errorprone.matchers.Description;
import com.google.errorprone.matchers.Matcher;
import com.google.errorprone.matchers.Matchers;
import com.sun.source.tree.MemberReferenceTree;
import com.sun.source.tree.MethodInvocationTree;
import com.sun.source.tree.Tree;

@AutoService(BugChecker.class)
@BugPattern(
        severity = BugPattern.SeverityLevel.ERROR,
        summary = "You should avoid using incubating methods where possible, since they have very weak stability"
                + " guarantees. You can explicitly disable this check on a case-by-case basis using"
                + " @SuppressWarnings(\"IncubatingMethod\").")
public final class IncubatingMethod extends BugChecker
        implements BugChecker.MethodInvocationTreeMatcher, BugChecker.MemberReferenceTreeMatcher {

    private static final String INCUBATING = "com.palantir.conjure.java.lib.internal.Incubating";

    private static final Matcher INCUBATING_MATCHER = Matchers.symbolHasAnnotation(INCUBATING);
    private static final Matcher IN_INCUBATING_MATCHER =
            Matchers.enclosingMethod(Matchers.symbolHasAnnotation(INCUBATING));

    @Override
    public Description matchMethodInvocation(MethodInvocationTree tree, VisitorState state) {
        return checkTree(tree, state);
    }

    @Override
    public Description matchMemberReference(MemberReferenceTree tree, VisitorState state) {
        return checkTree(tree, state);
    }

    private Description checkTree(Tree tree, VisitorState state) {
        if (!INCUBATING_MATCHER.matches(tree, state)) {
            return Description.NO_MATCH;
        }

        if (IN_INCUBATING_MATCHER.matches(tree, state)) {
            return Description.NO_MATCH;
        }

        // Allow users to test incubating endpoints in test code without complaining.
        if (TestCheckUtils.isTestCode(state)) {
            return Description.NO_MATCH;
        }

        return describeMatch(tree);
    }
}