1 /* 2 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"). 5 * You may not use this file except in compliance with the License. 6 * A copy of the License is located at 7 * 8 * http://aws.amazon.com/apache2.0 9 * 10 * or in the "license" file accompanying this file. This file is distributed 11 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either 12 * express or implied. See the License for the specific language governing 13 * permissions and limitations under the License. 14 */ 15 16 package software.amazon.awssdk.buildtools.checkstyle; 17 18 import com.puppycrawl.tools.checkstyle.api.AbstractCheck; 19 import com.puppycrawl.tools.checkstyle.api.DetailAST; 20 import com.puppycrawl.tools.checkstyle.api.TokenTypes; 21 import com.puppycrawl.tools.checkstyle.utils.AnnotationUtil; 22 import com.puppycrawl.tools.checkstyle.utils.ScopeUtil; 23 import java.util.Arrays; 24 import java.util.List; 25 26 /** 27 * A rule that checks if sdk annotation is missing on any non-test classes. Inner classes are ignored. 28 */ 29 public class MissingSdkAnnotationCheck extends AbstractCheck { 30 31 private static final List<String> SDK_ANNOTATIONS = Arrays.asList("SdkPublicApi", "SdkInternalApi", "SdkProtectedApi"); 32 33 @Override getDefaultTokens()34 public int[] getDefaultTokens() { 35 return getRequiredTokens(); 36 } 37 38 @Override getAcceptableTokens()39 public int[] getAcceptableTokens() { 40 return getRequiredTokens(); 41 } 42 43 @Override getRequiredTokens()44 public int[] getRequiredTokens() { 45 return new int[] { 46 TokenTypes.CLASS_DEF, 47 TokenTypes.INTERFACE_DEF 48 }; 49 } 50 51 @Override visitToken(DetailAST ast)52 public void visitToken(DetailAST ast) { 53 if (!ScopeUtil.isOuterMostType(ast) || SDK_ANNOTATIONS.stream().anyMatch(a -> AnnotationUtil.containsAnnotation 54 (ast, a))) { 55 return; 56 } 57 58 log(ast, "SDK annotation is missing on this class. eg: @SdkProtectedApi"); 59 } 60 } 61