AvoidStarImportCheck

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> com >> puppycrawl >> tools >> checkstyle >> checks >> [ imports overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck

SOURCE |

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

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

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

All Implemented Interfaces:: com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable

public class AvoidStarImportCheck
extends com.puppycrawl.tools.checkstyle.api.Check

Check that finds import statements that use the * notation.

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

An example of how to configure the check is:

 <module name="AvoidStarImport">
   <property name="excludes" value="java.io,java.net"/>
 </module>

The optional "excludes" property allows for certain packages like java.io or java.net to be exempted from the rule. Note that the excludes property is not recursive, subpackages of excluded packages are not automatically excluded.

Version:: 1.0

Field Summary

private java.lang.String[] mExcludes
          the packages to exempt from this check

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

AvoidStarImportCheck()


Method Summary

int[] getDefaultTokens()
          Returns the default token a check is interested in.

void setExcludes(java.lang.String[] aExcludes)
          Sets the list of packages to exempt from the check.

void visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)
          Called to process a token.

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

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

mExcludes

private java.lang.String[] mExcludes

the packages to exempt from this check

Constructor Detail