Overview Package Class Use Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

com.puppycrawl.tools.checkstyle.checks.imports

Class IllegalImportCheck

Implemented Interfaces:
Configurable, Contextualizable
public class IllegalImportCheck
extends Check
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.
Version:
1.0
Authors:
Oliver Burn
Lars Kühne

Constructor Summary

IllegalImportCheck()
Creates a new IllegalImportCheck instance.

Method Summary

int[]
getDefaultTokens()
void
setIllegalPkgs(String[] aFrom)
Set the list of illegal packages.
void
visitToken(DetailAST aAST)

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

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

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

getId, getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, log, log, log, setId, setSeverity

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

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Constructor Details

IllegalImportCheck

public IllegalImportCheck()
Creates a new IllegalImportCheck instance.

Method Details

getDefaultTokens

public int[] getDefaultTokens()
Overrides:
getDefaultTokens in interface Check

setIllegalPkgs

public void setIllegalPkgs(String[] aFrom)
Set the list of illegal packages.
Parameters:
aFrom - array of illegal packages

visitToken

public void visitToken(DetailAST aAST)
Overrides:
visitToken in interface Check

Overview Package Class Use Tree Index Deprecated About
Back to the Checkstyle Home Page