001////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code for adherence to a set of rules.
003// Copyright (C) 2001-2019 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.StatelessCheck;
023import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
024import com.puppycrawl.tools.checkstyle.api.DetailAST;
025import com.puppycrawl.tools.checkstyle.api.TokenTypes;
026import com.puppycrawl.tools.checkstyle.utils.AnnotationUtil;
027
028/**
029 * <p>
030 * This check makes sure that all package annotations are in the
031 * package-info.java file.
032 * </p>
033 * <p>
034 * According to the Java Language Specification.
035 * </p>
036 * <p>
037 * The JLS does not enforce the placement of package annotations.
038 * This placement may vary based on implementation. The JLS
039 * does highly recommend that all package annotations are
040 * placed in the package-info.java file.
041 *
042 * See <a
043 * href="https://docs.oracle.com/javase/specs/jls/se11/html/jls-7.html#jls-7.4.1">
044 * Java Language Specification, &#167;7.4.1</a>.
045 * </p>
046 * <p>
047 * To configure the check:
048 * </p>
049 * <pre>
050 * &lt;module name=&quot;PackageAnnotation&quot;/&gt;
051 * </pre>
052 *
053 * @since 5.0
054 */
055@StatelessCheck
056public class PackageAnnotationCheck extends AbstractCheck {
057
058    /**
059     * A key is pointing to the warning message text in "messages.properties"
060     * file.
061     */
062    public static final String MSG_KEY = "annotation.package.location";
063
064    @Override
065    public int[] getDefaultTokens() {
066        return getRequiredTokens();
067    }
068
069    @Override
070    public int[] getRequiredTokens() {
071        return new int[] {
072            TokenTypes.PACKAGE_DEF,
073        };
074    }
075
076    @Override
077    public int[] getAcceptableTokens() {
078        return getRequiredTokens();
079    }
080
081    @Override
082    public void visitToken(final DetailAST ast) {
083        final boolean containsAnnotation =
084            AnnotationUtil.containsAnnotation(ast);
085        final boolean inPackageInfo =
086            getFileContents().inPackageInfo();
087
088        if (containsAnnotation && !inPackageInfo) {
089            log(ast.getLineNo(), MSG_KEY);
090        }
091    }
092
093}