|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.puppycrawl.tools.checkstyle.api.AutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.Check
com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck
com.puppycrawl.tools.checkstyle.checks.GenericIllegalRegexpCheck
public class GenericIllegalRegexpCheck
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>
Constructor Summary | |
---|---|
GenericIllegalRegexpCheck()
Instantiates an new GenericIllegalRegexpCheck. |
Method Summary | |
---|---|
void |
beginTree(DetailAST aRootAST)
Called before the starting to process a tree. |
int[] |
getDefaultTokens()
Returns the default token a check is interested in. |
java.lang.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(java.lang.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 |
---|
destroy, finishTree, getAcceptableTokens, getClassLoader, 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, 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 |
Constructor Detail |
---|
public GenericIllegalRegexpCheck()
Method Detail |
---|
public void setMessage(java.lang.String aMessage)
aMessage
- custom message which should be used
to report about violations.public java.lang.String getMessage()
public void setIgnoreCase(boolean aCaseInsensitive)
aCaseInsensitive
- true if the match is case insensitive.public void setIgnoreComments(boolean aIgnoreComments)
aIgnoreComments
- True if comments should be ignored.public int[] getDefaultTokens()
getDefaultTokens
in class Check
TokenTypes
public void beginTree(DetailAST aRootAST)
beginTree
in class Check
aRootAST
- the root of the tree
|
Back to the Checkstyle Home Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |