Class IllegalImportCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable

    public class IllegalImportCheck
    extends AbstractCheck

    Checks for imports from a set of illegal packages. By default, the check rejects all sun.* packages since programs that contain direct calls to the sun.* packages are not 100% Pure Java.

    To reject other packages, set property illegalPkgs to a comma-separated list of the illegal packages.

    An example of how to configure the check is:

     <module name="IllegalImport"/>
     

    An example of how to configure the check so that it rejects packages java.io.* and java.sql.* is

     <module name="IllegalImport">
        <property name="illegalPkgs" value="java.io, java.sql"/>
     </module>
    
     Compatible with Java 1.5 source.
    
     
    Author:
    Oliver Burn, Lars Kühne
    • Constructor Detail

      • IllegalImportCheck

        public IllegalImportCheck()
        Creates a new IllegalImportCheck instance.
    • Method Detail

      • setIllegalPkgs

        public final void setIllegalPkgs​(String... from)
        Set the list of illegal packages.
        Parameters:
        from - array of illegal packages
      • setIllegalClasses

        public void setIllegalClasses​(String... from)
        Set the list of illegal classes.
        Parameters:
        from - array of illegal classes
      • setRegexp

        public void setRegexp​(boolean regexp)
        Controls whether the packages or class names should be interpreted as regular expressions.
        Parameters:
        regexp - a Boolean value
      • 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