com.thomasjensen.checkstyle.addons.checks.regexp

Class RegexpOnStringCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.AbstractCheck

com.thomasjensen.checkstyle.addons.checks.AbstractAddonsCheck

com.thomasjensen.checkstyle.addons.checks.regexp.RegexpOnStringCheck

All Implemented Interfaces:

com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable

public class RegexpOnStringCheck
extends AbstractAddonsCheck

This check applies a regular expression to String literals found in the source.

Documentation

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AutomaticBean.OutputStreamOptions

Constructor Summary

Constructors

Constructor and Description
RegexpOnStringCheck()

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.Integer>	getRelevantTokens() The tokens which this check is interested in.
void	setRegexp(java.lang.String pRegexp) Setter.
protected void	visitToken(BinaryName pBinaryClassName, com.puppycrawl.tools.checkstyle.api.DetailAST pAst) Called to process a token.

Methods inherited from class com.thomasjensen.checkstyle.addons.checks.AbstractAddonsCheck

beginTree, finishTree, finishTree, getAcceptableTokens, getApiFixer, getClassDeclarationPosition, getCurrentBinaryName, getCurrentSimpleName, getDefaultTokens, getMyPackage, getRequiredTokens, leaveKnownType, leaveToken, leaveToken, visitKnownType, visitToken

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

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RegexpOnStringCheck

public RegexpOnStringCheck()

Method Detail

getRelevantTokens

public java.util.Set<java.lang.Integer> getRelevantTokens()

Description copied from class: AbstractAddonsCheck

The tokens which this check is interested in. Will be added to the tokens of the base class.

Specified by:

getRelevantTokens in class AbstractAddonsCheck

Returns:

the relevant tokens

setRegexp

public void setRegexp(java.lang.String pRegexp)

Setter.

Parameters:

pRegexp - the new value of regexp

visitToken

protected void visitToken(@Nullable
                          BinaryName pBinaryClassName,
                          @Nonnull
                          com.puppycrawl.tools.checkstyle.api.DetailAST pAst)

Description copied from class: AbstractAddonsCheck

Called to process a token.

Overrides:

visitToken in class AbstractAddonsCheck

Parameters:

pBinaryClassName - the currently active binary class name

pAst - the token to process