com.puppycrawl.tools.checkstyle.checks.imports
Class UnusedImportsCheck

java.lang.Object
  extended by com.puppycrawl.tools.checkstyle.api.AutomaticBean
      extended by com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
          extended by com.puppycrawl.tools.checkstyle.api.Check
              extended by com.puppycrawl.tools.checkstyle.checks.DeclarationCollector
                  extended by com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck
All Implemented Interfaces:
Configurable, Contextualizable

public class UnusedImportsCheck
extends DeclarationCollector

Checks for unused import statements.

An example of how to configure the check is:

 <module name="UnusedImports"/>
 
Compatible with Java 1.5 source.

Version:
1.1
Author:
Oliver Burn

Constructor Summary
UnusedImportsCheck()
          Default constructor.
 
Method Summary
 void beginTree(DetailAST aRootAST)
          Called before the starting to process a tree.
 void finishTree(DetailAST aRootAST)
          Called after finished processing a tree.
 int[] getDefaultTokens()
          Returns the default token a check is interested in.
 int[] getRequiredTokens()
          The tokens that this check must be registered for.
 void visitToken(DetailAST aAST)
          Called to process a token.
 
Methods inherited from class com.puppycrawl.tools.checkstyle.checks.DeclarationCollector
isClassField, isDeclared, leaveToken
 
Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check
destroy, getAcceptableTokens, getClassLoader, getFileContents, getLines, getTabWidth, getTokenNames, init, 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, 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
 

Constructor Detail

UnusedImportsCheck

public UnusedImportsCheck()
Default constructor.

Method Detail

beginTree

public void beginTree(DetailAST aRootAST)
Called before the starting to process a tree. Ideal place to initialise information that is to be collected whilst processing a tree.

Overrides:
beginTree in class DeclarationCollector
Parameters:
aRootAST - the root of the tree

finishTree

public void finishTree(DetailAST aRootAST)
Called after finished processing a tree. Ideal place to report on information collected whilst processing a tree.

Overrides:
finishTree in class Check
Parameters:
aRootAST - the root of the tree

getDefaultTokens

public int[] getDefaultTokens()
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 Check
Returns:
the default tokens
See Also:
TokenTypes

getRequiredTokens

public int[] getRequiredTokens()
The tokens that this check must be registered for.

Overrides:
getRequiredTokens in class Check
Returns:
the token set this must be registered for.
See Also:
TokenTypes

visitToken

public void visitToken(DetailAST aAST)
Called to process a token.

Overrides:
visitToken in class DeclarationCollector
Parameters:
aAST - the token to process

Back to the Checkstyle Home Page