IllegalImportCheck

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> com >> puppycrawl >> tools >> checkstyle >> [ checks overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of com.puppycrawl.tools.checkstyle.checks.IllegalImportCheck

SOURCE |

Download com.puppycrawl.tools.checkstyle.checks.IllegalImportCheck

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.puppycrawl.tools.checkstyle.checks
Class IllegalImportCheck

java.lang.Object
  com.puppycrawl.tools.checkstyle.api.AutomaticBean
      com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
          com.puppycrawl.tools.checkstyle.api.Check
              com.puppycrawl.tools.checkstyle.checks.AbstractImportCheck
                  com.puppycrawl.tools.checkstyle.checks.IllegalImportCheck

All Implemented Interfaces:: com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable

public class IllegalImportCheck
extends AbstractImportCheck

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>

Version:: 1.0

Field Summary

private java.lang.String[] mIllegalPkgs
          list of illegal packages

Fields inherited from class com.puppycrawl.tools.checkstyle.api.Check

Fields inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

Fields inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

Constructor Summary

IllegalImportCheck()
          Creates a new IllegalImportCheck instance.

Method Summary

int[] getDefaultTokens()
          Returns the default token a check is interested in.

private boolean isIllegalImport(java.lang.String aImportText)
          Checks if an import is from a package that must not be used.

void setIllegalPkgs(java.lang.String[] aFrom)
          Set the list of illegal packages.

void visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)
          Called to process a token.

Methods inherited from class com.puppycrawl.tools.checkstyle.checks.AbstractImportCheck

getImportText

Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check

beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mIllegalPkgs

private java.lang.String[] mIllegalPkgs

list of illegal packages

Constructor Detail