Package com.puppycrawl.tools.checkstyle.checks.imports

Class AvoidStarImportCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.AbstractAutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.AbstractCheck

com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class AvoidStarImportCheck
extends AbstractCheck

Checks that there are no import statements that use the * notation.

Rationale: Importing all classes from a package or static members from a class leads to tight coupling between packages or classes and might lead to problems when a new version of a library introduces name clashes.

Note that property excludes is not recursive, subpackages of excluded packages are not automatically excluded.

• Property allowClassImports - Control whether to allow starred class imports like import java.util.*;. Type is boolean. Default value is false.
• Property allowStaticMemberImports - Control whether to allow starred static member imports like import static org.junit.Assert.*;. Type is boolean. Default value is false.
• Property excludes - Specify packages where starred class imports are allowed and classes where starred static member imports are allowed. Type is java.lang.String[]. Default value is "".

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

• import.avoidStar

Since:

3.0

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean

AbstractAutomaticBean.OutputStreamOptions

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	allowClassImports	Control whether to allow starred class imports like import java.util.*;.
private boolean	allowStaticMemberImports	Control whether to allow starred static member imports like import static org.junit.Assert.*;.
private Set<String>	excludes	Specify packages where starred class imports are allowed and classes where starred static member imports are allowed.
static String	MSG_KEY	A key is pointing to the warning message text in "messages.properties" file.
private static String	STAR_IMPORT_SUFFIX	Suffix for the star import.

Constructor Summary

Constructors

Constructor	Description
AvoidStarImportCheck()

Method Summary

Modifier and Type	Method	Description
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.
private void	logsStarredImportViolation(DetailAST startingDot)	Gets the full import identifier.
void	setAllowClassImports(boolean allow)	Setter to control whether to allow starred class imports like import java.util.*;.
void	setAllowStaticMemberImports(boolean allow)	Setter to control whether to allow starred static member imports like import static org.junit.Assert.*;.
void	setExcludes(String... excludesParam)	Setter to specify packages where starred class imports are allowed and classes where starred static member imports are allowed.
void	visitToken(DetailAST ast)	Called to process a token.

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

beginTree, clearViolations, destroy, finishTree, getFileContents, getFilePath, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, init, isCommentNodesRequired, leaveToken, log, log, log, setFileContents, setTabWidth, setTokens

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

finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean

configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object

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

Field Detail

MSG_KEY

public static final String MSG_KEY

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

See Also:

Constant Field Values

STAR_IMPORT_SUFFIX

private static final String STAR_IMPORT_SUFFIX

Suffix for the star import.

See Also:

Constant Field Values

excludes

private final Set<String> excludes

Specify packages where starred class imports are allowed and classes where starred static member imports are allowed.

allowClassImports

private boolean allowClassImports

Control whether to allow starred class imports like import java.util.*;.

allowStaticMemberImports

private boolean allowStaticMemberImports

Control whether to allow starred static member imports like import static org.junit.Assert.*;.

Constructor Detail

AvoidStarImportCheck

public AvoidStarImportCheck()

Method Detail

getDefaultTokens

public int[] getDefaultTokens()

Description copied from class: AbstractCheck

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 AbstractCheck

Returns:

the default tokens

See Also:

TokenTypes

getAcceptableTokens

public int[] getAcceptableTokens()

Description copied from class: AbstractCheck

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.

Specified by:

getAcceptableTokens in class AbstractCheck

Returns:

the token set this check is designed for.

See Also:

TokenTypes

getRequiredTokens

public int[] getRequiredTokens()

Description copied from class: AbstractCheck

The tokens that this check must be registered for.

Specified by:

getRequiredTokens in class AbstractCheck

Returns:

the token set this must be registered for.

See Also:

TokenTypes

setExcludes

public void setExcludes(String... excludesParam)

Setter to specify packages where starred class imports are allowed and classes where starred static member imports are allowed.

Parameters:

excludesParam - package names/fully-qualifies class names where star imports are ok

Since:

3.2

setAllowClassImports

public void setAllowClassImports(boolean allow)

Setter to control whether to allow starred class imports like import java.util.*;.

Parameters:

allow - true to allow false to disallow

Since:

5.3

setAllowStaticMemberImports

public void setAllowStaticMemberImports(boolean allow)

Setter to control whether to allow starred static member imports like import static org.junit.Assert.*;.

Parameters:

allow - true to allow false to disallow

Since:

5.3

visitToken

public void visitToken(DetailAST ast)

Description copied from class: AbstractCheck

Called to process a token.

Overrides:

visitToken in class AbstractCheck

Parameters:

ast - the token to process

logsStarredImportViolation

private void logsStarredImportViolation(DetailAST startingDot)

Gets the full import identifier. If the import is a starred import and it's not excluded then a violation is logged.

Parameters:

startingDot - the starting dot for the import statement