com.puppycrawl.tools.checkstyle.checks.imports
public class ImportOrderCheck extends AbstractOptionCheck<ImportOrderOption>
ImportOrderOption
Example:
<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>
Group descriptions enclosed in slashes are interpreted as regular expressions. If multiple groups match, the one matching a longer substring of the imported name will take precedence, with ties broken first in favor of earlier matches and finally in favor of the first matching group.
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 and Description |
---|
ImportOrderCheck()
Groups static imports under each group.
|
Modifier and Type | Method and Description |
---|---|
void |
beginTree(DetailAST aRootAST)
Called before the starting to process a tree.
|
int[] |
getDefaultTokens()
Returns the default token a check is interested in.
|
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.
|
getAbstractOption, setOption
destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
public ImportOrderCheck()
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 Check
TokenTypes
public void beginTree(DetailAST aRootAST)
Check
public void visitToken(DetailAST aAST)
Check
visitToken
in class Check
aAST
- the token to processCopyright © 2001-2014. All Rights Reserved.