LoosePackageCouplingRule (PMD Java 7.0.0 API)

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.design.LoosePackageCouplingRule

All Implemented Interfaces:

AstVisitor, JavaVisitor, Rule, PropertySource
```
public class LoosePackageCouplingRule
extends AbstractJavaRule
```
The loose package coupling Rule can be used to ensure coupling outside of a package hierarchy is minimized to all but an allowed set of classes from within the package hierarchy.
For example, supposed you have the following package hierarchy:
- org.sample
- org.sample.impl
- org.sample.util
And the allowed class org.sample.SampleInterface.
This rule can be used to ensure that all classes within the org.sample package and its sub-packages are not used outside of the org.sample package hierarchy. Further, the only allowed usage outside of a class in the org.sample hierarchy would be via org.sample.SampleInterface.

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

LoosePackageCouplingRule()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`checksNothing()`
`String`	`dysfunctionReason()`
`protected List<String>`	`getRestrictedPackages()`
`protected boolean`	`isAllowedClass(ASTImportDeclaration node)`
`protected boolean`	`isContainingPackage(String pkg1, String pkg2)`
`Object`	`visit(ASTCompilationUnit node, Object data)`
`Object`	`visit(ASTImportDeclaration node, Object data)`

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, buildTargetSelector, 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, visitJavaNode

Methods inherited from interface net.sourceforge.pmd.properties.PropertySource
definePropertyDescriptor, getOverriddenPropertiesByPropertyDescriptor, getOverriddenPropertyDescriptors, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, isPropertyOverridden, setProperty

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

Constructor Detail
- LoosePackageCouplingRule
```
public LoosePackageCouplingRule()
```

Method Detail

visit

public Object visit(ASTCompilationUnit node,
                    Object data)

visit

public Object visit(ASTImportDeclaration node,
                    Object data)

getRestrictedPackages

protected List<String> getRestrictedPackages()

isContainingPackage

protected boolean isContainingPackage(String pkg1,
                                      String pkg2)

isAllowedClass

protected boolean isAllowedClass(ASTImportDeclaration node)

checksNothing
```
public boolean checksNothing()
```

dysfunctionReason
```
public String dysfunctionReason()
```
See Also:

PropertySource.dysfunctionReason()