Package org.codenarc.rule.comments
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
-
-
Field Summary
-
Fields inherited from class org.codenarc.rule.AbstractAstVisitorRule
CLOSURE_TEXT, DEFAULT_CONST_NAME, DEFAULT_FIELD_NAME, DEFAULT_TEST_CLASS_NAMES, DEFAULT_TEST_FILES, DEFAULT_VAR_NAME
-
-
Constructor Summary
Constructors Constructor Description AbstractJavadocEmptyTagRule()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
applyTo(SourceCode sourceCode, java.util.List<Violation> violations)
Apply this rule to the specified source and return a list of violations (or an empty List)boolean
getAllowMultiline()
groovy.lang.MetaClass
getMetaClass()
int
getPriority()
java.lang.Object
getProperty(java.lang.String property)
protected abstract java.lang.String
getTag()
java.lang.Object
invokeMethod(java.lang.String method, java.lang.Object arguments)
boolean
isAllowMultiline()
void
setAllowMultiline(boolean value)
void
setMetaClass(groovy.lang.MetaClass mc)
void
setPriority(int value)
Set the priority for this rulevoid
setProperty(java.lang.String property, java.lang.Object value)
-
Methods inherited from class org.codenarc.rule.AbstractAstVisitorRule
getApplyToClassNames, getAstVisitor, getAstVisitorClass, getDoNotApplyToClassNames, setApplyToClassNames, setDoNotApplyToClassNames, shouldApplyThisRuleTo
-
Methods inherited from class org.codenarc.rule.AbstractRule
applyTo, createViolation, createViolation, createViolationForImport, createViolationForImport, getApplyToFileNames, getApplyToFilesMatching, getCompilerPhase, getDescription, getDoNotApplyToFileNames, getDoNotApplyToFilesMatching, getName, getViolationMessage, isEnabled, isReady, setApplyToFileNames, setApplyToFilesMatching, setDescription, setDoNotApplyToFileNames, setDoNotApplyToFilesMatching, setEnabled, setName, setViolationMessage, toString, validate
-
-
-
-
Method Detail
-
getMetaClass
public groovy.lang.MetaClass getMetaClass()
- Specified by:
getMetaClass
in interfacegroovy.lang.GroovyObject
-
setMetaClass
public void setMetaClass(groovy.lang.MetaClass mc)
- Specified by:
setMetaClass
in interfacegroovy.lang.GroovyObject
-
invokeMethod
public java.lang.Object invokeMethod(java.lang.String method, java.lang.Object arguments)
- Specified by:
invokeMethod
in interfacegroovy.lang.GroovyObject
-
getProperty
public java.lang.Object getProperty(java.lang.String property)
- Specified by:
getProperty
in interfacegroovy.lang.GroovyObject
-
setProperty
public void setProperty(java.lang.String property, java.lang.Object value)
- Specified by:
setProperty
in interfacegroovy.lang.GroovyObject
-
getPriority
public int getPriority()
- Specified by:
getPriority
in interfaceRule
- Specified by:
getPriority
in classAbstractRule
- 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 classAbstractRule
- 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 java.lang.String getTag()
-
applyTo
public void applyTo(SourceCode sourceCode, java.util.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 classAbstractAstVisitorRule
- Parameters:
sourceCode
- - the source to apply this rule toviolations
- - the List of violations to which new violations from this rule are to be added
-
-