com.puppycrawl.tools.checkstyle.checks.coding

Class MultipleStringLiteralsCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.Check

com.puppycrawl.tools.checkstyle.checks.coding.MultipleStringLiteralsCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class MultipleStringLiteralsCheck
extends Check

Checks for multiple occurrences of the same string literal within a single file.

Author:

Daniel Grenner

Field Summary

Fields

Modifier and Type	Field and Description
static String	MSG_KEY A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors

Constructor and Description
MultipleStringLiteralsCheck() Construct an instance with default values.

Method Summary

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.
void	setAllowedDuplicates(int allowedDuplicates) Sets the maximum allowed duplicates of a string.
void	setIgnoreOccurrenceContext(String... strRep) Adds a set of tokens the check is interested in.
void	setIgnoreStringsRegexp(String ignoreStringsRegexp) Sets regular expression pattern for ignored strings.
void	visitToken(DetailAST ast) Called to process a token.

Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check

destroy, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, isCommentNodesRequired, 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

Field Detail

MSG_KEY

public static final String MSG_KEY

A key is pointing to the warning message text in "messages.properties" file.

See Also:

Constant Field Values

Constructor Detail

MultipleStringLiteralsCheck

public MultipleStringLiteralsCheck()

Construct an instance with default values.

Method Detail

setAllowedDuplicates

public void setAllowedDuplicates(int allowedDuplicates)

Sets the maximum allowed duplicates of a string.

Parameters:

allowedDuplicates - The maximum number of duplicates.

setIgnoreStringsRegexp

public final void setIgnoreStringsRegexp(String ignoreStringsRegexp)

Sets regular expression pattern for ignored strings.

Parameters:

ignoreStringsRegexp - regular expression pattern for ignored strings

Throws:

org.apache.commons.beanutils.ConversionException - if unable to create Pattern object

setIgnoreOccurrenceContext

public final void setIgnoreOccurrenceContext(String... strRep)

Adds a set of tokens the check is interested in.

Parameters:

strRep - the string representation of the tokens interested in

getDefaultTokens

public int[] getDefaultTokens()

Description copied from class: Check

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 class Check

Returns:

the default tokens

See Also:

TokenTypes

getAcceptableTokens

public int[] getAcceptableTokens()

Description copied from class: Check

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.

Overrides:

getAcceptableTokens in class Check

Returns:

the token set this check is designed for.

See Also:

TokenTypes

getRequiredTokens

public int[] getRequiredTokens()

Description copied from class: Check

The tokens that this check must be registered for.

Overrides:

getRequiredTokens in class Check

Returns:

the token set this must be registered for.

See Also:

TokenTypes

visitToken

public void visitToken(DetailAST ast)

Description copied from class: Check

Called to process a token.

Overrides:

visitToken in class Check

Parameters:

ast - the token to process

beginTree

public void beginTree(DetailAST rootAST)

Description copied from class: Check

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 class Check

Parameters:

rootAST - the root of the tree

finishTree

public void finishTree(DetailAST rootAST)

Description copied from class: Check

Called after finished processing a tree. Ideal place to report on information collected whilst processing a tree.

Overrides:

finishTree in class Check

Parameters:

rootAST - the root of the tree