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

Modifier and Type	Method	Description
groovy.lang.MetaClass	getMetaClass()
String	getName()
Object	getProperty(String property)
protected String	getTag()
Object	invokeMethod(String method, Object arguments)
void	setMetaClass(groovy.lang.MetaClass mc)
void	setName(String value)	Set the unique name for this rule
void	setProperty(String property, 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JavadocMissingExceptionDescriptionRule

public JavadocMissingExceptionDescriptionRule()

Method Detail

getMetaClass

public groovy.lang.MetaClass getMetaClass()

Specified by:

getMetaClass in interface groovy.lang.GroovyObject

Overrides:

getMetaClass in class AbstractJavadocMissingDescriptionRule

setMetaClass

public void setMetaClass(groovy.lang.MetaClass mc)

Specified by:

setMetaClass in interface groovy.lang.GroovyObject

Overrides:

setMetaClass in class AbstractJavadocMissingDescriptionRule

invokeMethod

public Object invokeMethod(String method,
                           Object arguments)

Specified by:

invokeMethod in interface groovy.lang.GroovyObject

Overrides:

invokeMethod in class AbstractJavadocMissingDescriptionRule

getProperty

public Object getProperty(String property)

Specified by:

getProperty in interface groovy.lang.GroovyObject

Overrides:

getProperty in class AbstractJavadocMissingDescriptionRule

setProperty

public void setProperty(String property,
                        Object value)

Specified by:

setProperty in interface groovy.lang.GroovyObject

Overrides:

setProperty in class AbstractJavadocMissingDescriptionRule

getName

public String getName()

Specified by:

getName in interface Rule

Specified by:

getName in class AbstractRule

Returns:

the unique name for this rule

setName

public void setName(String value)

Description copied from class: AbstractRule

Set the unique name for this rule

Specified by:

setName in class AbstractRule

Parameters:

value - - the name for this rule; this should be unique

getTag

protected String getTag()

Specified by:

getTag in class AbstractJavadocMissingDescriptionRule