001//////////////////////////////////////////////////////////////////////////////// 002// checkstyle: Checks Java source code for adherence to a set of rules. 003// Copyright (C) 2001-2015 the original author or authors. 004// 005// This library is free software; you can redistribute it and/or 006// modify it under the terms of the GNU Lesser General Public 007// License as published by the Free Software Foundation; either 008// version 2.1 of the License, or (at your option) any later version. 009// 010// This library is distributed in the hope that it will be useful, 011// but WITHOUT ANY WARRANTY; without even the implied warranty of 012// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 013// Lesser General Public License for more details. 014// 015// You should have received a copy of the GNU Lesser General Public 016// License along with this library; if not, write to the Free Software 017// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 018//////////////////////////////////////////////////////////////////////////////// 019 020package com.puppycrawl.tools.checkstyle.checks.annotation; 021 022import com.puppycrawl.tools.checkstyle.api.Check; 023import com.puppycrawl.tools.checkstyle.api.DetailAST; 024import com.puppycrawl.tools.checkstyle.api.TokenTypes; 025import com.puppycrawl.tools.checkstyle.utils.AnnotationUtility; 026 027/** 028 * This check makes sure that all package annotations are in the 029 * package-info.java file. 030 * 031 * <p> 032 * According to the Java Language Specification. 033 * </p> 034 * 035 * <p> 036 * The JLS does not enforce the placement of package annotations. 037 * This placement may vary based on implementation. The JLS 038 * does highly recommend that all package annotations are 039 * placed in the package-info.java file. 040 * 041 * See <a 042 * href="http://docs.oracle.com/javase/specs/jls/se8/html/jls-7.html#jls-7.4.1"> 043 * Java Language Specification, section 7.4.1</a>. 044 * </p> 045 * @author Travis Schneeberger 046 */ 047public class PackageAnnotationCheck extends Check { 048 049 @Override 050 public int[] getDefaultTokens() { 051 return getRequiredTokens(); 052 } 053 054 @Override 055 public int[] getRequiredTokens() { 056 return new int[] { 057 TokenTypes.PACKAGE_DEF, 058 }; 059 } 060 061 @Override 062 public int[] getAcceptableTokens() { 063 return getRequiredTokens(); 064 } 065 066 @Override 067 public void visitToken(final DetailAST ast) { 068 final boolean containsAnnotation = 069 AnnotationUtility.containsAnnotation(ast); 070 final boolean inPackageInfo = 071 getFileContents().inPackageInfo(); 072 073 if (containsAnnotation && !inPackageInfo) { 074 log(ast.getLine(), "annotation.package.location"); 075 } 076 } 077}