org.apache.maven.plugins.enforcer
Class DefaultEnforcementRuleHelper

java.lang.Object
  extended by org.apache.maven.plugins.enforcer.DefaultEnforcementRuleHelper
All Implemented Interfaces:
EnforcerRuleHelper, org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator

public class DefaultEnforcementRuleHelper
extends java.lang.Object
implements EnforcerRuleHelper

Default implementation of the EnforcementRuleHelper interface. This is used to help retrieve information from the session and provide useful elements like the log.

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

Constructor Summary
DefaultEnforcementRuleHelper(org.apache.maven.execution.MavenSession session, org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator evaluator, org.apache.maven.plugin.logging.Log log, org.codehaus.plexus.PlexusContainer container)
          Instantiates a new default enforcement rule helper.
 
Method Summary
 java.io.File alignToBaseDirectory(java.io.File theFile)
           
 java.lang.Object evaluate(java.lang.String theExpression)
           
 java.lang.Object getComponent(java.lang.Class clazz)
           
 java.lang.Object getComponent(java.lang.String theComponentKey)
           
 java.lang.Object getComponent(java.lang.String theRole, java.lang.String theRoleHint)
           
 java.util.List getComponentList(java.lang.String theRole)
           
 java.util.Map getComponentMap(java.lang.String theRole)
           
 org.codehaus.plexus.PlexusContainer getContainer()
           
 org.apache.maven.plugin.logging.Log getLog()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultEnforcementRuleHelper

public DefaultEnforcementRuleHelper(org.apache.maven.execution.MavenSession session,
                                    org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator evaluator,
                                    org.apache.maven.plugin.logging.Log log,
                                    org.codehaus.plexus.PlexusContainer container)
Instantiates a new default enforcement rule helper.

Parameters:
session - the session
evaluator - the evaluator
log - the log
container - the container
Method Detail

getLog

public org.apache.maven.plugin.logging.Log getLog()
Specified by:
getLog in interface EnforcerRuleHelper

alignToBaseDirectory

public java.io.File alignToBaseDirectory(java.io.File theFile)
Specified by:
alignToBaseDirectory in interface org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator

evaluate

public java.lang.Object evaluate(java.lang.String theExpression)
                          throws org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException
Specified by:
evaluate in interface org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator
Throws:
org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException

getComponent

public java.lang.Object getComponent(java.lang.Class clazz)
                              throws org.codehaus.plexus.component.repository.exception.ComponentLookupException
Specified by:
getComponent in interface EnforcerRuleHelper
Throws:
org.codehaus.plexus.component.repository.exception.ComponentLookupException

getComponent

public java.lang.Object getComponent(java.lang.String theComponentKey)
                              throws org.codehaus.plexus.component.repository.exception.ComponentLookupException
Specified by:
getComponent in interface EnforcerRuleHelper
Throws:
org.codehaus.plexus.component.repository.exception.ComponentLookupException

getComponent

public java.lang.Object getComponent(java.lang.String theRole,
                                     java.lang.String theRoleHint)
                              throws org.codehaus.plexus.component.repository.exception.ComponentLookupException
Specified by:
getComponent in interface EnforcerRuleHelper
Throws:
org.codehaus.plexus.component.repository.exception.ComponentLookupException

getComponentList

public java.util.List getComponentList(java.lang.String theRole)
                                throws org.codehaus.plexus.component.repository.exception.ComponentLookupException
Specified by:
getComponentList in interface EnforcerRuleHelper
Throws:
org.codehaus.plexus.component.repository.exception.ComponentLookupException

getComponentMap

public java.util.Map getComponentMap(java.lang.String theRole)
                              throws org.codehaus.plexus.component.repository.exception.ComponentLookupException
Specified by:
getComponentMap in interface EnforcerRuleHelper
Throws:
org.codehaus.plexus.component.repository.exception.ComponentLookupException

getContainer

public org.codehaus.plexus.PlexusContainer getContainer()
Specified by:
getContainer in interface EnforcerRuleHelper


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