org.apache.maven.plugins.enforcer
Class AbstractBanDependencies

java.lang.Object
  extended by org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule
      extended by org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule
          extended by org.apache.maven.plugins.enforcer.AbstractBanDependencies
All Implemented Interfaces:
EnforcerRule
Direct Known Subclasses:
BannedDependencies, NoSnapshots, RequireReleaseDeps

public abstract class AbstractBanDependencies
extends AbstractNonCacheableEnforcerRule

Abstract Rule for banning dependencies.

Version:
$Id: AbstractBanDependencies.java 675992 2008-07-11 15:42:48Z hboutemy $
Author:
Brian Fox

Field Summary
 boolean searchTransitive
          Specify if transitive dependencies should be searched (default) or only look at direct dependencies.
 
Fields inherited from class org.apache.maven.plugins.enforcer.AbstractStandardEnforcerRule
message
 
Constructor Summary
AbstractBanDependencies()
           
 
Method Summary
protected abstract  java.util.Set checkDependencies(java.util.Set dependencies, org.apache.maven.plugin.logging.Log log)
          Checks the set of dependencies against the list of excludes.
 void execute(EnforcerRuleHelper helper)
          Execute the rule.
 java.lang.String getMessage()
          Gets the message.
 boolean isSearchTransitive()
          Checks if is search transitive.
 void setMessage(java.lang.String theMessage)
          Sets the message.
 void setSearchTransitive(boolean theSearchTransitive)
          Sets the search transitive.
 
Methods inherited from class org.apache.maven.plugins.enforcer.AbstractNonCacheableEnforcerRule
getCacheId, isCacheable, isResultValid
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

searchTransitive

public boolean searchTransitive
Specify if transitive dependencies should be searched (default) or only look at direct dependencies.

Constructor Detail

AbstractBanDependencies

public AbstractBanDependencies()
Method Detail

execute

public void execute(EnforcerRuleHelper helper)
             throws EnforcerRuleException
Execute the rule.

Parameters:
helper - the helper
Throws:
EnforcerRuleException - the enforcer rule exception

checkDependencies

protected abstract java.util.Set checkDependencies(java.util.Set dependencies,
                                                   org.apache.maven.plugin.logging.Log log)
                                            throws EnforcerRuleException
Checks the set of dependencies against the list of excludes.

Parameters:
dependencies - the dependencies
log - the log
Returns:
the sets the
Throws:
EnforcerRuleException - the enforcer rule exception

getMessage

public java.lang.String getMessage()
Gets the message.

Returns:
the message

setMessage

public void setMessage(java.lang.String theMessage)
Sets the message.

Parameters:
theMessage - the message to set

isSearchTransitive

public boolean isSearchTransitive()
Checks if is search transitive.

Returns:
the searchTransitive

setSearchTransitive

public void setSearchTransitive(boolean theSearchTransitive)
Sets the search transitive.

Parameters:
theSearchTransitive - the searchTransitive to set


Copyright © 2007-2011 Apache Software Foundation. All Rights Reserved.