Class PackageDeclarationCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable

    public final class PackageDeclarationCheck
    extends AbstractCheck
    Ensures there is a package declaration. Optionally checks if directory structure matches package name. Rationale: Classes that live in the null package cannot be imported. Many novice developers are not aware of this. Packages provide logical namespace to classes and should be stored in the form of directory levels to provide physical grouping to your classes. These directories are added to the classpath so that your classes are visible to JVM when it runs the code.
    • Field Detail

      • MSG_KEY_MISSING

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

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

        private static final int DEFAULT_LINE_NUMBER
        Line number used to log violation when no AST nodes are present in file.
        See Also:
        Constant Field Values
      • defined

        private boolean defined
        Is package defined.
      • matchDirectoryStructure

        private boolean matchDirectoryStructure
        Whether to check for directory and package name match.
    • Constructor Detail

      • PackageDeclarationCheck

        public PackageDeclarationCheck()
    • Method Detail

      • setMatchDirectoryStructure

        public void setMatchDirectoryStructure​(boolean matchDirectoryStructure)
        Set whether to check for directory and package name match.
        Parameters:
        matchDirectoryStructure - the new value.
      • 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
      • beginTree

        public void beginTree​(DetailAST ast)
        Description copied from class: AbstractCheck
        Called before the starting to process a tree. Ideal place to initialize information that is to be collected whilst processing a tree.
        Overrides:
        beginTree in class AbstractCheck
        Parameters:
        ast - the root of the tree
      • finishTree

        public void finishTree​(DetailAST ast)
        Description copied from class: AbstractCheck
        Called after finished processing a tree. Ideal place to report on information collected whilst processing a tree.
        Overrides:
        finishTree in class AbstractCheck
        Parameters:
        ast - the root of the tree
      • getDirectoryName

        private java.lang.String getDirectoryName()
        Returns the directory name this file is in.
        Returns:
        Directory name.