public class ImportControlCheck extends AbstractCheck implements ExternalResourceHolder
Modifier and Type | Field and Description |
---|---|
static String |
MSG_DISALLOWED
A key is pointing to the warning message text in "messages.properties"
file.
|
static String |
MSG_MISSING_FILE
A key is pointing to the warning message text in "messages.properties"
file.
|
static String |
MSG_UNKNOWN_PKG
A key is pointing to the warning message text in "messages.properties"
file.
|
Constructor and Description |
---|
ImportControlCheck() |
Modifier and Type | Method and Description |
---|---|
void |
beginTree(DetailAST rootAST)
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.
|
Set<String> |
getExternalResourceLocations()
Returns a set of external configuration resource locations which are used by the module.
|
int[] |
getRequiredTokens()
The tokens that this check must be registered for.
|
void |
setFile(String name)
Set the name for the file containing the import control
configuration.
|
void |
setUrl(String url)
Set the parameter for the url containing the import control
configuration.
|
void |
visitToken(DetailAST ast)
Called to process a token.
|
destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
public static final String MSG_MISSING_FILE
public static final String MSG_UNKNOWN_PKG
public static final String MSG_DISALLOWED
public ImportControlCheck()
public int[] getDefaultTokens()
AbstractCheck
getDefaultTokens
in class AbstractCheck
TokenTypes
public int[] getAcceptableTokens()
AbstractCheck
getAcceptableTokens
in class AbstractCheck
TokenTypes
public int[] getRequiredTokens()
AbstractCheck
getRequiredTokens
in class AbstractCheck
TokenTypes
public void beginTree(DetailAST rootAST)
AbstractCheck
beginTree
in class AbstractCheck
rootAST
- the root of the treepublic void visitToken(DetailAST ast)
AbstractCheck
visitToken
in class AbstractCheck
ast
- the token to processpublic Set<String> getExternalResourceLocations()
ExternalResourceHolder
NullPointerException
in Checker
.
Such behaviour will signal that your module (check or filter) is designed incorrectrly.
It make sence to return an empty set from 'getExternalResourceLocations()'
only for composite modules like TreeWalker
.getExternalResourceLocations
in interface ExternalResourceHolder
public void setFile(String name)
name
- the name of the file to load.org.apache.commons.beanutils.ConversionException
- on error loading the file.Copyright © 2001–2016. All rights reserved.