Package com.puppycrawl.tools.checkstyle.checks.annotation

Class PackageAnnotationCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable
    public class PackageAnnotationCheck
extends AbstractCheck

    Checks that all package annotations are in the package-info.java file.

    For Java SE8 and above, placement of package annotations in the package-info.java file is enforced by the compiler and this check is not necessary.

    For Java SE7 and below, the Java Language Specification highly recommends but doesn't require that annotations are placed in the package-info.java file, and this check can help to enforce that placement.

    See Java Language Specification, §7.4.1 for more info.

    To configure the check: 

     <module name="PackageAnnotation"/>

    Example of validating MyClass.java:

     @Deprecated
 package com.example.annotations.packageannotation; //violation

    Example of fixing violation in MyClass.java:

     package com.example.annotations.packageannotation; //ok

    Example of validating package-info.java:

     @Deprecated
 package com.example.annotations.packageannotation; //ok

    Parent is com.puppycrawl.tools.checkstyle.TreeWalker

    Violation Message Keys:

    • annotation.package.location
    Since:
    5.0

    • Field Detail

      • MSG_KEY

        public static final java.lang.String MSG_KEY
        A key is pointing to the warning message text in "messages.properties" file.
        See Also:
        Constant Field Values

    • Constructor Detail

      • PackageAnnotationCheck

        public PackageAnnotationCheck()

    • Method Detail

      • getDefaultTokens

        public int[] getDefaultTokens()
        Description copied from class: AbstractCheck
        Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.
        Specified by:
        getDefaultTokens in class AbstractCheck
        Returns:
        the default tokens
        See Also:
        TokenTypes

      • getRequiredTokens

        public int[] getRequiredTokens()
        Description copied from class: AbstractCheck
        The tokens that this check must be registered for.
        Specified by:
        getRequiredTokens in class AbstractCheck
        Returns:
        the token set this must be registered for.
        See Also:
        TokenTypes

      • getAcceptableTokens

        public int[] getAcceptableTokens()
        Description copied from class: AbstractCheck
        The configurable token set. Used to protect Checks against malicious users who specify an unacceptable token set in the configuration file. The default implementation returns the check's default tokens.
        Specified by:
        getAcceptableTokens in class AbstractCheck
        Returns:
        the token set this check is designed for.
        See Also:
        TokenTypes