com.puppycrawl.tools.checkstyle.checks.imports

Class RedundantImportCheck

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.RedundantImportCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class RedundantImportCheck
extends Check

Checks for imports that are redundant. An import statement is considered redundant if:

• It is a duplicate of another import. This is, when a class is imported more than once.
• The class non-statically imported is from the java.lang package. For example importing java.lang.String.
• The class non-statically imported is from the same package as the current package.

An example of how to configure the check is:

 <module name="RedundantImport"/>
 

Compatible with Java 1.5 source.

Author:

Oliver Burn

Field Summary

Fields

Modifier and Type	Field and Description
static String	MSG_DUPLICATE A key is pointing to the warning message text in "messages.properties" file.
static String	MSG_LANG A key is pointing to the warning message text in "messages.properties" file.
static String	MSG_SAME A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors

Constructor and Description
RedundantImportCheck()

Method Summary

Modifier and Type	Method and Description
void	beginTree(DetailAST aRootAST) Called before the starting to process a tree.
int[]	getAcceptableTokens() The configurable token set.
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 ast) Called to process a token.

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

destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens

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

getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, 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

MSG_LANG

public static final String MSG_LANG

A key is pointing to the warning message text in "messages.properties" file.

See Also:

Constant Field Values

MSG_SAME

public static final String MSG_SAME

A key is pointing to the warning message text in "messages.properties" file.

See Also:

Constant Field Values

MSG_DUPLICATE

public static final String MSG_DUPLICATE

A key is pointing to the warning message text in "messages.properties" file.

See Also:

Constant Field Values

Constructor Detail

RedundantImportCheck

public RedundantImportCheck()

Method Detail

beginTree

public void beginTree(DetailAST aRootAST)

Description copied from class: Check

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

Overrides:

beginTree in class Check

Parameters:

aRootAST - the root of the tree

getDefaultTokens

public int[] getDefaultTokens()

Description copied from class: Check

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

getAcceptableTokens

public int[] getAcceptableTokens()

Description copied from class: Check

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.

Overrides:

getAcceptableTokens in class Check

Returns:

the token set this check is designed for.

See Also:

TokenTypes

getRequiredTokens

public int[] getRequiredTokens()

Description copied from class: Check

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 ast)

Description copied from class: Check

Called to process a token.

Overrides:

visitToken in class Check

Parameters:

ast - the token to process