GenericIllegalRegexpCheck

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> com >> puppycrawl >> tools >> checkstyle >> [ checks overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of com.puppycrawl.tools.checkstyle.checks.GenericIllegalRegexpCheck

SOURCE |

Download com.puppycrawl.tools.checkstyle.checks.GenericIllegalRegexpCheck

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.puppycrawl.tools.checkstyle.checks
Class GenericIllegalRegexpCheck

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.AbstractFormatCheck
                  com.puppycrawl.tools.checkstyle.checks.GenericIllegalRegexpCheck

All Implemented Interfaces:: com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable

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>

Field Summary

private boolean mIgnoreCase
          case insensitive?

private java.lang.String mMessage
          Custom message for report if illegal regexp found ignored if empty.

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

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

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

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

Constructor Summary

GenericIllegalRegexpCheck()
          Instantiates an new GenericIllegalRegexpCheck.

Method Summary

void beginTree(com.puppycrawl.tools.checkstyle.api.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.

org.apache.regexp.RE getRegexp()


void setIgnoreCase(boolean aCaseInsensitive)
          Set whether or not the match is case sensitive.

void setMessage(java.lang.String aMessage)
          Setter for message property.

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

getFormat, 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

getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, 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

mMessage

private java.lang.String mMessage

Custom message for report if illegal regexp found ignored if empty.

mIgnoreCase

private boolean mIgnoreCase

case insensitive?

Constructor Detail