org.apache.maven.plugin.enforcer
Class AbstractBanDependencies

java.lang.Object
  extended by org.apache.maven.plugin.enforcer.AbstractBanDependencies
All Implemented Interfaces:
org.apache.maven.shared.enforcer.rule.api.EnforcerRule
Direct Known Subclasses:
BannedDependencies, NoSnapshots

public abstract class AbstractBanDependencies
extends java.lang.Object
implements org.apache.maven.shared.enforcer.rule.api.EnforcerRule

Abstract Rule for banning dependencies

Version:
$Id$
Author:
Brian Fox

Field Summary
 java.lang.String message
          Specify a friendly message if the rule fails.
 boolean searchTransitive
          Specify if transitive dependencies should be searched (default) or only look at direct dependencies
 
Constructor Summary
AbstractBanDependencies()
           
 
Method Summary
protected abstract  java.util.Set checkDependencies(java.util.Set dependencies)
          Checks the set of dependencies against the list of excludes
 void execute(org.apache.maven.shared.enforcer.rule.api.EnforcerRuleHelper helper)
          Execute the rule.
 java.lang.String getMessage()
           
 boolean isSearchTransitive()
           
 void setMessage(java.lang.String theMessage)
           
 void setSearchTransitive(boolean theSearchTransitive)
           
 
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


message

public java.lang.String message
Specify a friendly message if the rule fails.

Constructor Detail

AbstractBanDependencies

public AbstractBanDependencies()
Method Detail

execute

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

Specified by:
execute in interface org.apache.maven.shared.enforcer.rule.api.EnforcerRule
Throws:
org.apache.maven.shared.enforcer.rule.api.EnforcerRuleException

checkDependencies

protected abstract java.util.Set checkDependencies(java.util.Set dependencies)
                                            throws org.apache.maven.shared.enforcer.rule.api.EnforcerRuleException
Checks the set of dependencies against the list of excludes

Parameters:
dependencies -
Returns:
Throws:
org.apache.maven.shared.enforcer.rule.api.EnforcerRuleException

getMessage

public java.lang.String getMessage()
Returns:
the message

setMessage

public void setMessage(java.lang.String theMessage)
Parameters:
theMessage - the message to set

isSearchTransitive

public boolean isSearchTransitive()
Returns:
the searchTransitive

setSearchTransitive

public void setSearchTransitive(boolean theSearchTransitive)
Parameters:
theSearchTransitive - the searchTransitive to set


Copyright © 2002-2009 Apache Software Foundation. All Rights Reserved.