net.sourceforge.pmd.rules.strictexception
Class ExceptionSignatureDeclaration

java.lang.Object
  extended bynet.sourceforge.pmd.ast.JavaParserVisitorAdapter
      extended bynet.sourceforge.pmd.AbstractRule
          extended bynet.sourceforge.pmd.rules.strictexception.ExceptionSignatureDeclaration
All Implemented Interfaces:
JavaParserVisitor, Rule

public class ExceptionSignatureDeclaration
extends AbstractRule

Since:
1.2
Version:
1.0
Author:
Trond Andersen

Field Summary
 
Fields inherited from class net.sourceforge.pmd.AbstractRule
 
Fields inherited from interface net.sourceforge.pmd.Rule
LOWEST_PRIORITY, PRIORITIES
 
Constructor Summary
ExceptionSignatureDeclaration()
           
 
Method Summary
private  void evaluateExceptions(java.util.List exceptionList, RuleContext context)
          Checks all exceptions for possible violation on the exception declaration.
private  boolean hasContent(java.util.List nameList)
           
private  boolean hasDeclaredExceptionInSignature(ASTName exception)
          Checks if the given value is defined as Exception and the parent is either a method or constructor declaration.
private  boolean isParentSignatureDeclaration(ASTName exception)
           
 java.lang.Object visit(ASTConstructorDeclaration constructorDeclaration, java.lang.Object o)
           
 java.lang.Object visit(ASTMethodDeclaration methodDeclaration, java.lang.Object o)
           
 
Methods inherited from class net.sourceforge.pmd.AbstractRule
addProperty, apply, createRuleViolation, createRuleViolation, equals, getBooleanProperty, getDescription, getDoubleProperty, getExample, getIntProperty, getMessage, getName, getPriority, getPriorityName, getProperties, getStringProperty, hashCode, hasProperty, include, setDescription, setExample, setInclude, setMessage, setName, setPriority, visitAll
 
Methods inherited from class net.sourceforge.pmd.ast.JavaParserVisitorAdapter
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 class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ExceptionSignatureDeclaration

public ExceptionSignatureDeclaration()
Method Detail

visit

public java.lang.Object visit(ASTMethodDeclaration methodDeclaration,
                              java.lang.Object o)
Specified by:
visit in interface JavaParserVisitor
Overrides:
visit in class JavaParserVisitorAdapter

visit

public java.lang.Object visit(ASTConstructorDeclaration constructorDeclaration,
                              java.lang.Object o)
Specified by:
visit in interface JavaParserVisitor
Overrides:
visit in class JavaParserVisitorAdapter

evaluateExceptions

private void evaluateExceptions(java.util.List exceptionList,
                                RuleContext context)
Checks all exceptions for possible violation on the exception declaration.

Parameters:
exceptionList - containing all exception for declaration
context -

hasDeclaredExceptionInSignature

private boolean hasDeclaredExceptionInSignature(ASTName exception)
Checks if the given value is defined as Exception and the parent is either a method or constructor declaration.

Parameters:
exception - to evaluate
Returns:
true if Exception is declared and has proper parents

isParentSignatureDeclaration

private boolean isParentSignatureDeclaration(ASTName exception)
Parameters:
exception - to evaluate
Returns:
true if parent node is either a method or constructor declaration

hasContent

private boolean hasContent(java.util.List nameList)