Class AbstractJavadocEmptyTagRule

java.lang.Object
org.codenarc.rule.AbstractRule
org.codenarc.rule.AbstractAstVisitorRule
org.codenarc.rule.comments.AbstractJavadocEmptyTagRule
All Implemented Interfaces:
groovy.lang.GroovyObject, Rule
Direct Known Subclasses:
JavadocEmptyAuthorTagRule, JavadocEmptyExceptionTagRule, JavadocEmptyParamTagRule, JavadocEmptyReturnTagRule, JavadocEmptySeeTagRule, JavadocEmptySinceTagRule, JavadocEmptyThrowsTagRule, JavadocEmptyVersionTagRule

public abstract class AbstractJavadocEmptyTagRule extends AbstractAstVisitorRule implements groovy.lang.GroovyObject
  • Constructor Details

    • AbstractJavadocEmptyTagRule

      public AbstractJavadocEmptyTagRule()
  • Method Details

    • getMetaClass

      public groovy.lang.MetaClass getMetaClass()
      Specified by:
      getMetaClass in interface groovy.lang.GroovyObject
    • setMetaClass

      public void setMetaClass(groovy.lang.MetaClass mc)
      Specified by:
      setMetaClass in interface groovy.lang.GroovyObject
    • invokeMethod

      public Object invokeMethod(String method, Object arguments)
      Specified by:
      invokeMethod in interface groovy.lang.GroovyObject
    • getProperty

      public Object getProperty(String property)
      Specified by:
      getProperty in interface groovy.lang.GroovyObject
    • setProperty

      public void setProperty(String property, Object value)
      Specified by:
      setProperty in interface groovy.lang.GroovyObject
    • getPriority

      public int getPriority()
      Specified by:
      getPriority in interface Rule
      Specified by:
      getPriority in class AbstractRule
      Returns:
      the priority of this rule, between 1 (highest priority) and 3 (lowest priority), inclusive.
    • setPriority

      public void setPriority(int value)
      Description copied from class: AbstractRule
      Set the priority for this rule
      Specified by:
      setPriority in class AbstractRule
      Parameters:
      value - - the priority of this rule, between 1 (highest priority) and 3 (lowest priority), inclusive.
    • getAllowMultiline

      public boolean getAllowMultiline()
    • isAllowMultiline

      public boolean isAllowMultiline()
    • setAllowMultiline

      public void setAllowMultiline(boolean value)
    • getTag

      protected abstract String getTag()
    • applyTo

      public void applyTo(SourceCode sourceCode, List<Violation> violations)
      Description copied from class: AbstractRule
      Apply this rule to the specified source and return a list of violations (or an empty List)
      Overrides:
      applyTo in class AbstractAstVisitorRule
      Parameters:
      sourceCode - - the source to apply this rule to
      violations - - the List of violations to which new violations from this rule are to be added