Class SuppressWarningsHolder
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.api.AutomaticBean
-
- com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
-
- com.puppycrawl.tools.checkstyle.api.AbstractCheck
-
- com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder
-
- All Implemented Interfaces:
Configurable
,Contextualizable
public class SuppressWarningsHolder extends AbstractCheck
Maintains a set of check suppressions fromSuppressWarnings
annotations.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
AutomaticBean.OutputStreamOptions
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.
-
Constructor Summary
Constructors Constructor Description SuppressWarningsHolder()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
beginTree(DetailAST rootAST)
Called before the starting to process a tree.int[]
getAcceptableTokens()
The configurable token set.static java.lang.String
getAlias(java.lang.String sourceName)
Returns the alias for the source name of a check.static java.lang.String
getDefaultAlias(java.lang.String sourceName)
Returns the default alias for the source name of a check, which is the source name in lower case with any dotted prefix or "Check" suffix removed.int[]
getDefaultTokens()
Returns the default token a check is interested in.int[]
getRequiredTokens()
The tokens that this check must be registered for.static boolean
isSuppressed(AuditEvent event)
Checks for a suppression of a check with the given source name and location in the last file processed.void
setAliasList(java.lang.String... aliasList)
Registers a list of source name aliases based on a comma-separated list ofsource=alias
items, such ascom.puppycrawl.tools.checkstyle.checks.sizes.ParameterNumberCheck= paramnum
.void
visitToken(DetailAST ast)
Called to process a token.-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
clearMessages, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, log, setClassLoader, 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.api.AutomaticBean
configure, contextualize, getConfiguration, setupChild
-
-
-
-
Field Detail
-
MSG_KEY
public static final java.lang.String MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
-
Method Detail
-
getDefaultAlias
public static java.lang.String getDefaultAlias(java.lang.String sourceName)
Returns the default alias for the source name of a check, which is the source name in lower case with any dotted prefix or "Check" suffix removed.- Parameters:
sourceName
- the source name of the check (generally the class name)- Returns:
- the default alias for the given check
-
getAlias
public static java.lang.String getAlias(java.lang.String sourceName)
Returns the alias for the source name of a check. If an alias has been explicitly registered viaregisterAlias(String, String)
, that alias is returned; otherwise, the default alias is used.- Parameters:
sourceName
- the source name of the check (generally the class name)- Returns:
- the current alias for the given check
-
setAliasList
public void setAliasList(java.lang.String... aliasList)
Registers a list of source name aliases based on a comma-separated list ofsource=alias
items, such ascom.puppycrawl.tools.checkstyle.checks.sizes.ParameterNumberCheck= paramnum
.- Parameters:
aliasList
- the list of comma-separated alias assignments
-
isSuppressed
public static boolean isSuppressed(AuditEvent event)
Checks for a suppression of a check with the given source name and location in the last file processed.- Parameters:
event
- audit event.- Returns:
- whether the check with the given name is suppressed at the given source location
-
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 classAbstractCheck
- 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 classAbstractCheck
- 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 classAbstractCheck
- Returns:
- the token set this must be registered for.
- See Also:
TokenTypes
-
beginTree
public void beginTree(DetailAST rootAST)
Description copied from class:AbstractCheck
Called before the starting to process a tree. Ideal place to initialize information that is to be collected whilst processing a tree.- Overrides:
beginTree
in classAbstractCheck
- Parameters:
rootAST
- the root of the tree
-
visitToken
public void visitToken(DetailAST ast)
Description copied from class:AbstractCheck
Called to process a token.- Overrides:
visitToken
in classAbstractCheck
- Parameters:
ast
- the token to process
-
-