|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.puppycrawl.tools.checkstyle.api.AutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.Check
com.puppycrawl.tools.checkstyle.checks.AbstractOptionCheck<ImportOrderOption>
com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
public class ImportOrderCheck
ImportOrderOptionExample:
<module name="ImportOrder">
<property name="groups" value="java,javax"/>
<property name="ordered" value="true"/>
<property name="caseSensitive" value="false"/>
<property name="option" value="above"/>
</module>
There is always a wildcard group to which everything not in a named group
belongs. If an import does not match a named group, the group belongs to
this wildcard group. The wildcard group position can be specified using the
* character.
Defaults:
Compatible with Java 1.5 source.
| Constructor Summary | |
|---|---|
ImportOrderCheck()
Groups static imports under each group. |
|
| Method Summary | |
|---|---|
void |
beginTree(DetailAST aRootAST)
Called before the starting to process 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 |
setCaseSensitive(boolean aCaseSensitive)
Sets whether string comparison should be case sensitive or not. |
void |
setGroups(String[] aGroups)
Sets the list of package groups and the order they should occur in the file. |
void |
setOrdered(boolean aOrdered)
Sets whether or not imports should be ordered within any one group of imports. |
void |
setSeparated(boolean aSeparated)
Sets whether or not groups of imports must be separated from one another by at least one blank line. |
void |
visitToken(DetailAST aAST)
Called to process a token. |
| Methods inherited from class com.puppycrawl.tools.checkstyle.checks.AbstractOptionCheck |
|---|
getAbstractOption, setOption |
| Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check |
|---|
destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLines, getTabWidth, getTokenNames, init, 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 |
| Constructor Detail |
|---|
public ImportOrderCheck()
| Method Detail |
|---|
public void setGroups(String[] aGroups)
aGroups - a comma-separated list of package names/prefixes.public void setOrdered(boolean aOrdered)
aOrdered - whether lexicographic ordering of imports within a group
required or not.public void setSeparated(boolean aSeparated)
aSeparated - whether groups should be separated by oen blank line.public void setCaseSensitive(boolean aCaseSensitive)
aCaseSensitive - whether string comparison should be case sensitive.public int[] getDefaultTokens()
Check
getDefaultTokens in class CheckTokenTypespublic int[] getRequiredTokens()
Check
getRequiredTokens in class CheckTokenTypespublic void beginTree(DetailAST aRootAST)
Check
beginTree in class CheckaRootAST - the root of the treepublic void visitToken(DetailAST aAST)
Check
visitToken in class CheckaAST - the token to process
|
Back to the Checkstyle Home Page | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||