Package org.codenarc.rule.comments
Class JavadocMissingExceptionDescriptionRule
- java.lang.Object
-
- org.codenarc.rule.AbstractRule
-
- org.codenarc.rule.AbstractAstVisitorRule
-
- org.codenarc.rule.comments.AbstractJavadocMissingDescriptionRule
-
- org.codenarc.rule.comments.JavadocMissingExceptionDescriptionRule
-
- All Implemented Interfaces:
groovy.lang.GroovyObject
,Rule
public class JavadocMissingExceptionDescriptionRule extends AbstractJavadocMissingDescriptionRule
-
-
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 JavadocMissingExceptionDescriptionRule()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description groovy.lang.MetaClass
getMetaClass()
java.lang.String
getName()
java.lang.Object
getProperty(java.lang.String property)
protected java.lang.String
getTag()
java.lang.Object
invokeMethod(java.lang.String method, java.lang.Object arguments)
void
setMetaClass(groovy.lang.MetaClass mc)
void
setName(java.lang.String value)
Set the unique name for this rulevoid
setProperty(java.lang.String property, java.lang.Object value)
-
Methods inherited from class org.codenarc.rule.comments.AbstractJavadocMissingDescriptionRule
applyTo, getAllowMultiline, getPriority, isAllowMultiline, setAllowMultiline, setPriority
-
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, getViolationMessage, isEnabled, isReady, setApplyToFileNames, setApplyToFilesMatching, setDescription, setDoNotApplyToFileNames, setDoNotApplyToFilesMatching, setEnabled, setViolationMessage, toString, validate
-
-
-
-
Method Detail
-
getMetaClass
public groovy.lang.MetaClass getMetaClass()
- Specified by:
getMetaClass
in interfacegroovy.lang.GroovyObject
- Overrides:
getMetaClass
in classAbstractJavadocMissingDescriptionRule
-
setMetaClass
public void setMetaClass(groovy.lang.MetaClass mc)
- Specified by:
setMetaClass
in interfacegroovy.lang.GroovyObject
- Overrides:
setMetaClass
in classAbstractJavadocMissingDescriptionRule
-
invokeMethod
public java.lang.Object invokeMethod(java.lang.String method, java.lang.Object arguments)
- Specified by:
invokeMethod
in interfacegroovy.lang.GroovyObject
- Overrides:
invokeMethod
in classAbstractJavadocMissingDescriptionRule
-
getProperty
public java.lang.Object getProperty(java.lang.String property)
- Specified by:
getProperty
in interfacegroovy.lang.GroovyObject
- Overrides:
getProperty
in classAbstractJavadocMissingDescriptionRule
-
setProperty
public void setProperty(java.lang.String property, java.lang.Object value)
- Specified by:
setProperty
in interfacegroovy.lang.GroovyObject
- Overrides:
setProperty
in classAbstractJavadocMissingDescriptionRule
-
getName
public java.lang.String getName()
- Specified by:
getName
in interfaceRule
- Specified by:
getName
in classAbstractRule
- Returns:
- the unique name for this rule
-
setName
public void setName(java.lang.String value)
Description copied from class:AbstractRule
Set the unique name for this rule- Specified by:
setName
in classAbstractRule
- Parameters:
value
- - the name for this rule; this should be unique
-
getTag
protected java.lang.String getTag()
- Specified by:
getTag
in classAbstractJavadocMissingDescriptionRule
-
-