com.twitter.common.checkstyle
Class JavadocMethodRegexCheck

java.lang.Object
  extended by com.puppycrawl.tools.checkstyle.api.AutomaticBean
      extended by com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
          extended by com.puppycrawl.tools.checkstyle.api.Check
              extended by com.puppycrawl.tools.checkstyle.checks.AbstractTypeAwareCheck
                  extended by com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
                      extended by com.twitter.common.checkstyle.JavadocMethodRegexCheck
All Implemented Interfaces:
com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable

public class JavadocMethodRegexCheck
extends com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck

A small extension to the JavadocMethodCheck. Only two additions are the ability to skip certain methods if they match a regex, and skip methods if they are short enough (number of non-blank lines) TODO(Alex Roetter): write a unittest


Nested Class Summary
 
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.checks.AbstractTypeAwareCheck
com.puppycrawl.tools.checkstyle.checks.AbstractTypeAwareCheck.ClassInfo, com.puppycrawl.tools.checkstyle.checks.AbstractTypeAwareCheck.Token
 
Constructor Summary
JavadocMethodRegexCheck()
           
 
Method Summary
protected  String getMessageBundle()
          For human readable error messages
protected  boolean isMissingJavadocAllowed(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)
           
 void setIgnoreMethodNamesRegex(String s)
           
 void setMinLineCount(int n)
           
 
Methods inherited from class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck
getAcceptableTokens, getDefaultTokens, logLoadError, processAST, setAllowMissingJavadoc, setAllowMissingParamTags, setAllowMissingPropertyJavadoc, setAllowMissingReturnTag, setAllowMissingThrowsTags, setAllowThrowsTagsForSubclasses, setAllowUndeclaredRTE, setExcludeScope, setScope
 
Methods inherited from class com.puppycrawl.tools.checkstyle.checks.AbstractTypeAwareCheck
beginTree, createClassInfo, findClassAlias, getCurrentClassName, getRequiredTokens, isSubclass, isUnchecked, leaveAST, leaveToken, logLoadErrorImpl, resolveClass, setLogLoadErrors, setSuppressLoadErrors, tryLoadClass, visitToken
 
Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check
destroy, finishTree, getClassLoader, getFileContents, getLines, getTabWidth, getTokenNames, init, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
 
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
getCustomMessages, getId, 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
 

Constructor Detail

JavadocMethodRegexCheck

public JavadocMethodRegexCheck()
Method Detail

setIgnoreMethodNamesRegex

public void setIgnoreMethodNamesRegex(String s)

setMinLineCount

public void setMinLineCount(int n)

isMissingJavadocAllowed

protected boolean isMissingJavadocAllowed(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)
Overrides:
isMissingJavadocAllowed in class com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck

getMessageBundle

protected String getMessageBundle()
For human readable error messages

Overrides:
getMessageBundle in class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter