Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> puppycrawl >> tools >> checkstyle >> checks >> [ imports overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

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

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.imports.UnusedImportsCheck

All Implemented Interfaces:

com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable

---

public class UnusedImportsCheck

extends com.puppycrawl.tools.checkstyle.api.Check

Checks for unused import statements.

An example of how to configure the check is:

 <module name="UnusedImports"/>
 

Version:

1.0

---

Field Summary
private  boolean	mCollect           flag to indicate when time to start collecting references
private  java.util.Set	mImports           set of the imports
private  java.util.Set	mReferenced           set of references - possibly to imports or other things

 

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

UnusedImportsCheck()

 

Method Summary
void	beginTree(com.puppycrawl.tools.checkstyle.api.DetailAST aRootAST)           Called before the starting to process a tree.
void	finishTree(com.puppycrawl.tools.checkstyle.api.DetailAST aRootAST)           Called after finished processing a tree.
int[]	getDefaultTokens()           Returns the default token a check is interested in.
private  void	processIdent(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)           Collects references made by IDENT.
private  void	processImport(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)           Collects the details of imports.
void	visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)           Called to process a token.

 

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

destroy, 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

mCollect

private boolean mCollect

flag to indicate when time to start collecting references

---

mImports

private final java.util.Set mImports

set of the imports

---

mReferenced

private final java.util.Set mReferenced

set of references - possibly to imports or other things

Constructor Detail

UnusedImportsCheck

public UnusedImportsCheck()

Method Detail

beginTree

public void beginTree(com.puppycrawl.tools.checkstyle.api.DetailAST aRootAST)

Description copied from class: com.puppycrawl.tools.checkstyle.api.Check

Called before the starting to process a tree. Ideal place to initialise information that is to be collected whilst processing a tree.

---

finishTree

public void finishTree(com.puppycrawl.tools.checkstyle.api.DetailAST aRootAST)

Description copied from class: com.puppycrawl.tools.checkstyle.api.Check

Called after finished processing a tree. Ideal place to report on information collected whilst processing a tree.

---

getDefaultTokens

public int[] getDefaultTokens()

Description copied from class: com.puppycrawl.tools.checkstyle.api.Check

Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.

---

visitToken

public void visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)

Description copied from class: com.puppycrawl.tools.checkstyle.api.Check

Called to process a token.

---

processIdent

private void processIdent(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)

Collects references made by IDENT.

---

processImport

private void processImport(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)

Collects the details of imports.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> puppycrawl >> tools >> checkstyle >> checks >> [ imports overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---