org.acm.seguin.pmd.rules
Class CouplingBetweenObjectsRule

java.lang.Object
  net.sourceforge.jrefactory.parser.JavaParserVisitorAdapter
      org.acm.seguin.pmd.AbstractRule
          org.acm.seguin.pmd.rules.CouplingBetweenObjectsRule

All Implemented Interfaces:

net.sourceforge.jrefactory.parser.JavaParserVisitor, Rule

public class CouplingBetweenObjectsRule
extends AbstractRule

CouplingBetweenObjectsRule attempts to capture all unique Class attributes, local variables, and return types to determine how many objects a class is coupled to. This is only a guage and isn't a hard and fast rule. The threshold value is configurable and should be determined accordingly

Since:

Feb 20, 2003

Author:

aglover

Field Summary

Fields inherited from interface org.acm.seguin.pmd.Rule

LOWEST_PRIORITY, PRIORITIES

Constructor Summary

CouplingBetweenObjectsRule()

Method Summary

java.lang.Object	visit(net.sourceforge.jrefactory.ast.ASTClassDeclaration node, java.lang.Object data) handles class declaration.
java.lang.Object	visit(net.sourceforge.jrefactory.ast.ASTCompilationUnit cu, java.lang.Object data) handles the source file
java.lang.Object	visit(net.sourceforge.jrefactory.ast.ASTFieldDeclaration node, java.lang.Object data) handles a field declaration - i.e.
java.lang.Object	visit(net.sourceforge.jrefactory.ast.ASTFormalParameter node, java.lang.Object data) handles a method parameter
java.lang.Object	visit(net.sourceforge.jrefactory.ast.ASTLocalVariableDeclaration node, java.lang.Object data) handles a local variable found in a method block
java.lang.Object	visit(net.sourceforge.jrefactory.ast.ASTResultType node, java.lang.Object data) handles a return type of a method

Methods inherited from class org.acm.seguin.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.jrefactory.parser.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, 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

CouplingBetweenObjectsRule

public CouplingBetweenObjectsRule()

Method Detail

visit

public java.lang.Object visit(net.sourceforge.jrefactory.ast.ASTCompilationUnit cu,
                              java.lang.Object data)

handles the source file

Specified by:

visit in interface net.sourceforge.jrefactory.parser.JavaParserVisitor

Overrides:

visit in class AbstractRule

Parameters:

cu - Description of Parameter

data - Description of Parameter

Returns:

Object

visit

public java.lang.Object visit(net.sourceforge.jrefactory.ast.ASTClassDeclaration node,
                              java.lang.Object data)

handles class declaration. I need this to capture class name. I think there is probably a better way to capture it; however, I don't know the framework well enough yet...

Specified by:

visit in interface net.sourceforge.jrefactory.parser.JavaParserVisitor

Overrides:

visit in class net.sourceforge.jrefactory.parser.JavaParserVisitorAdapter

Parameters:

node - Description of Parameter

data - Description of Parameter

Returns:

Object

visit

public java.lang.Object visit(net.sourceforge.jrefactory.ast.ASTResultType node,
                              java.lang.Object data)

handles a return type of a method

Specified by:

visit in interface net.sourceforge.jrefactory.parser.JavaParserVisitor

Overrides:

visit in class net.sourceforge.jrefactory.parser.JavaParserVisitorAdapter

Parameters:

node - Description of Parameter

data - Description of Parameter

Returns:

Object

visit

public java.lang.Object visit(net.sourceforge.jrefactory.ast.ASTLocalVariableDeclaration node,
                              java.lang.Object data)

handles a local variable found in a method block

Specified by:

visit in interface net.sourceforge.jrefactory.parser.JavaParserVisitor

Overrides:

visit in class net.sourceforge.jrefactory.parser.JavaParserVisitorAdapter

Parameters:

node - Description of Parameter

data - Description of Parameter

Returns:

Object

visit

public java.lang.Object visit(net.sourceforge.jrefactory.ast.ASTFormalParameter node,
                              java.lang.Object data)

handles a method parameter

Specified by:

visit in interface net.sourceforge.jrefactory.parser.JavaParserVisitor

Overrides:

visit in class net.sourceforge.jrefactory.parser.JavaParserVisitorAdapter

Parameters:

node - Description of Parameter

data - Description of Parameter

Returns:

Object

visit

public java.lang.Object visit(net.sourceforge.jrefactory.ast.ASTFieldDeclaration node,
                              java.lang.Object data)

handles a field declaration - i.e. an instance variable. Method doesn't care if variable is public/private/etc

Specified by:

visit in interface net.sourceforge.jrefactory.parser.JavaParserVisitor

Overrides:

visit in class net.sourceforge.jrefactory.parser.JavaParserVisitorAdapter

Parameters:

node - Description of Parameter

data - Description of Parameter

Returns:

Object