public class MultipleStringLiteralsCheck extends AbstractCheck
Modifier and Type | Class and Description |
---|---|
private static class |
MultipleStringLiteralsCheck.StringInfo
This class contains information about where a string was found.
|
Modifier and Type | Field and Description |
---|---|
private int |
allowedDuplicates
The allowed number of string duplicates in a file before an error is
generated.
|
private java.util.BitSet |
ignoreOccurrenceContext
Marks the TokenTypes where duplicate strings should be ignored.
|
private java.util.regex.Pattern |
ignoreStringsRegexp
Pattern for matching ignored strings.
|
static java.lang.String |
MSG_KEY
A key is pointing to the warning message text in "messages.properties"
file.
|
private java.util.Map<java.lang.String,java.util.List<MultipleStringLiteralsCheck.StringInfo>> |
stringMap
The found strings and their positions.
|
Constructor and Description |
---|
MultipleStringLiteralsCheck()
Construct an instance with default values.
|
Modifier and Type | Method and Description |
---|---|
void |
beginTree(DetailAST rootAST)
Called before the starting to process a tree.
|
void |
finishTree(DetailAST rootAST)
Called after finished processing a tree.
|
int[] |
getAcceptableTokens()
The configurable token set.
|
int[] |
getDefaultTokens()
Returns the default token a check is interested in.
|
int[] |
getRequiredTokens()
The tokens that this check must be registered for.
|
private boolean |
isInIgnoreOccurrenceContext(DetailAST ast)
Analyses the path from the AST root to a given AST for occurrences
of the token types in
ignoreOccurrenceContext . |
void |
setAllowedDuplicates(int allowedDuplicates)
Sets the maximum allowed duplicates of a string.
|
void |
setIgnoreOccurrenceContext(java.lang.String... strRep)
Adds a set of tokens the check is interested in.
|
void |
setIgnoreStringsRegexp(java.util.regex.Pattern ignoreStringsRegexp)
Sets regular expression pattern for ignored strings.
|
void |
visitToken(DetailAST ast)
Called to process a token.
|
destroy, 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 java.lang.String MSG_KEY
private final java.util.Map<java.lang.String,java.util.List<MultipleStringLiteralsCheck.StringInfo>> stringMap
<String, ArrayList>
, with the ArrayList containing StringInfo
objects.private final java.util.BitSet ignoreOccurrenceContext
private int allowedDuplicates
private java.util.regex.Pattern ignoreStringsRegexp
public MultipleStringLiteralsCheck()
public void setAllowedDuplicates(int allowedDuplicates)
allowedDuplicates
- The maximum number of duplicates.public final void setIgnoreStringsRegexp(java.util.regex.Pattern ignoreStringsRegexp)
ignoreStringsRegexp
- regular expression pattern for ignored stringspublic final void setIgnoreOccurrenceContext(java.lang.String... strRep)
strRep
- the string representation of the tokens interested inpublic 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 visitToken(DetailAST ast)
AbstractCheck
visitToken
in class AbstractCheck
ast
- the token to processprivate boolean isInIgnoreOccurrenceContext(DetailAST ast)
ignoreOccurrenceContext
.ast
- the node from where to start searching towards the root nodeignoreOccurrenceContext
.public void beginTree(DetailAST rootAST)
AbstractCheck
beginTree
in class AbstractCheck
rootAST
- the root of the treepublic void finishTree(DetailAST rootAST)
AbstractCheck
finishTree
in class AbstractCheck
rootAST
- the root of the tree