org.scijava.maven.plugin.enforcer

Class AbstractPackageEnforcementRule

java.lang.Object

org.scijava.maven.plugin.enforcer.AbstractPackageEnforcementRule

All Implemented Interfaces:

org.apache.maven.enforcer.rule.api.EnforcerRule

Direct Known Subclasses:

NoPackageCyclesRule, NoSubpackageDependenceRule

public abstract class AbstractPackageEnforcementRule
extends Object
implements org.apache.maven.enforcer.rule.api.EnforcerRule

Common functionality for writing an EnforcerRule dealing with the package hierarchy.

Author:

Ben Romberg, David Burkhart, Gabriel Selzer

Constructor Summary

Constructors

Constructor and Description
AbstractPackageEnforcementRule()

Method Summary

Modifier and Type	Method and Description
protected jdepend.framework.JDepend	createJDepend(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper helper)
void	execute(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper helper)
String	getCacheId()
boolean	isCacheable()
boolean	isResultValid(org.apache.maven.enforcer.rule.api.EnforcerRule arg0)
void	setExcludedPackages(List<String> excludedPackages)
void	setIncludedPackages(List<String> includedPackages)
void	setIncludeTests(boolean includeTests)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPackageEnforcementRule

public AbstractPackageEnforcementRule()

Method Detail

execute

public void execute(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper helper)
             throws org.apache.maven.enforcer.rule.api.EnforcerRuleException

Specified by:

execute in interface org.apache.maven.enforcer.rule.api.EnforcerRule

Throws:

org.apache.maven.enforcer.rule.api.EnforcerRuleException

getCacheId

public String getCacheId()

Specified by:

getCacheId in interface org.apache.maven.enforcer.rule.api.EnforcerRule

isCacheable

public boolean isCacheable()

Specified by:

isCacheable in interface org.apache.maven.enforcer.rule.api.EnforcerRule

isResultValid

public boolean isResultValid(org.apache.maven.enforcer.rule.api.EnforcerRule arg0)

Specified by:

isResultValid in interface org.apache.maven.enforcer.rule.api.EnforcerRule

setExcludedPackages

public void setExcludedPackages(List<String> excludedPackages)

setIncludedPackages

public void setIncludedPackages(List<String> includedPackages)

setIncludeTests

public void setIncludeTests(boolean includeTests)

createJDepend

protected jdepend.framework.JDepend createJDepend(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper helper)