Package net.sourceforge.pmd.lang.java.rule.design

Class SignatureDeclareThrowsExceptionRule

java.lang.Object

net.sourceforge.pmd.properties.AbstractPropertySource

net.sourceforge.pmd.lang.rule.AbstractRule

net.sourceforge.pmd.lang.java.rule.AbstractJavaRule

net.sourceforge.pmd.lang.java.rule.AbstractJavaRulechainRule

net.sourceforge.pmd.lang.java.rule.design.SignatureDeclareThrowsExceptionRule

All Implemented Interfaces:

net.sourceforge.pmd.lang.ast.AstVisitor, JavaVisitor, net.sourceforge.pmd.lang.rule.Rule, net.sourceforge.pmd.properties.PropertySource

public class SignatureDeclareThrowsExceptionRule
extends AbstractJavaRulechainRule

A method/constructor shouldn't explicitly throw java.lang.Exception, since it is unclear which exceptions that can be thrown from the methods. It might be difficult to document and understand such vague interfaces. Use either a class derived from RuntimeException or a checked exception.

This rule uses PMD's type resolution facilities, and can detect if the class implements or extends TestCase class

Author:

Trond Andersen

Since:

1.2

Version:

1.0

Field Summary

Fields inherited from interface net.sourceforge.pmd.lang.rule.Rule

VIOLATION_SUPPRESS_REGEX_DESCRIPTOR, VIOLATION_SUPPRESS_XPATH_DESCRIPTOR

Constructor Summary

Constructors

Constructor	Description
SignatureDeclareThrowsExceptionRule()

Method Summary

Modifier and Type	Method	Description
Object	visit(ASTThrowsList throwsList, Object o)

Methods inherited from class net.sourceforge.pmd.lang.java.rule.AbstractJavaRulechainRule

buildTargetSelector, visitJavaNode

Methods inherited from class net.sourceforge.pmd.lang.java.rule.AbstractJavaRule

apply, visitNode

Methods inherited from class net.sourceforge.pmd.lang.rule.AbstractRule

addExample, asCtx, deepCopy, end, equals, getDescription, getExamples, getExternalInfoUrl, getLanguage, getMaximumLanguageVersion, getMessage, getMinimumLanguageVersion, getName, getPriority, getPropertySourceType, getRuleClass, getRuleSetName, getSince, getTargetSelector, hashCode, isDeprecated, setDeprecated, setDescription, setExternalInfoUrl, setLanguage, setMaximumLanguageVersion, setMessage, setMinimumLanguageVersion, setName, setPriority, setRuleClass, setRuleSetName, setSince, start

Methods inherited from class net.sourceforge.pmd.properties.AbstractPropertySource

definePropertyDescriptor, getOverriddenPropertiesByPropertyDescriptor, getOverriddenPropertyDescriptors, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, isPropertyOverridden, setProperty

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sourceforge.pmd.lang.ast.AstVisitor

cannotVisit

Methods inherited from interface net.sourceforge.pmd.lang.java.ast.JavaVisitor

visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit

Methods inherited from interface net.sourceforge.pmd.properties.PropertySource

definePropertyDescriptor, dysfunctionReason, getOverriddenPropertiesByPropertyDescriptor, getOverriddenPropertyDescriptors, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, isPropertyOverridden, setProperty

Methods inherited from interface net.sourceforge.pmd.lang.rule.Rule

initialize

Constructor Detail

SignatureDeclareThrowsExceptionRule

public SignatureDeclareThrowsExceptionRule()

Method Detail

visit

public Object visit(ASTThrowsList throwsList,
                    Object o)