com.puppycrawl.tools.checkstyle.checks

Class GenericIllegalRegexpCheck

Implemented Interfaces:
Configurable, Contextualizable
Known Direct Subclasses:
IllegalTokenTextCheck

public class GenericIllegalRegexpCheck
extends AbstractFormatCheck

A generic check for code problems, the user can search for any pattern. This is similar to a recursive grep, only that it's integrated in checkstyle.

Rationale: This Check can be used to prototype checks and to find common bad pratice such as calling ex.printStacktrace(), System.out.println(), System.exit(), etc.

An example of how to configure the check for calls to System.out.println is:

 <module name="GenericIllegalRegexp">
    <property name="format" value="System\.out\.println"/>
 </module>
 
Authors:
lkuehne
Bill Schneider
Daniel Grenner

Constructor Summary

GenericIllegalRegexpCheck()
Instantiates an new GenericIllegalRegexpCheck.

Method Summary

void
beginTree(DetailAST aRootAST)
int[]
getDefaultTokens()
String
getMessage()
Getter for message property.
void
setIgnoreCase(boolean aCaseInsensitive)
Set whether or not the match is case sensitive.
void
setIgnoreComments(boolean aIgnoreComments)
Sets if comments should be ignored.
void
setMessage(String aMessage)
Setter for message property.

Methods inherited from class com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck

getFormat, getRegexp, setCompileFlags, setFormat

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

beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getDefaultTokens, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens, visitToken

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

getId, getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, log, log, log, setId, setSeverity

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

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Constructor Details

GenericIllegalRegexpCheck

public GenericIllegalRegexpCheck()
Instantiates an new GenericIllegalRegexpCheck.

Method Details

beginTree

public void beginTree(DetailAST aRootAST)
Overrides:
beginTree in interface Check

getDefaultTokens

public int[] getDefaultTokens()
Overrides:
getDefaultTokens in interface Check

getMessage

public String getMessage()
Getter for message property.
Returns:
custom message which should be used to report about violations.

setIgnoreCase

public void setIgnoreCase(boolean aCaseInsensitive)
Set whether or not the match is case sensitive.
Parameters:
aCaseInsensitive - true if the match is case insensitive.

setIgnoreComments

public void setIgnoreComments(boolean aIgnoreComments)
Sets if comments should be ignored.
Parameters:
aIgnoreComments - True if comments should be ignored.

setMessage

public void setMessage(String aMessage)
Setter for message property.
Parameters:
aMessage - custom message which should be used to report about violations.