org.apache.maven.plugins.enforcer

Class DefaultEnforcementRuleHelper

java.lang.Object

org.apache.maven.plugins.enforcer.DefaultEnforcementRuleHelper

All Implemented Interfaces:

org.apache.maven.enforcer.rule.api.EnforcerRuleHelper, org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator

public class DefaultEnforcementRuleHelper
extends Object
implements org.apache.maven.enforcer.rule.api.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$

Author:

Brian Fox

Constructor Summary

Constructors

Constructor and Description
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

Methods

Modifier and Type	Method and Description
File	alignToBaseDirectory(File theFile)
Object	evaluate(String theExpression)
Object	getComponent(Class clazz)
Object	getComponent(String theComponentKey)
Object	getComponent(String theRole, String theRoleHint)
List	getComponentList(String theRole)
Map	getComponentMap(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 org.apache.maven.enforcer.rule.api.EnforcerRuleHelper

alignToBaseDirectory

public File alignToBaseDirectory(File theFile)

Specified by:

alignToBaseDirectory in interface org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator

evaluate

public Object evaluate(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 Object getComponent(Class clazz)
                    throws org.codehaus.plexus.component.repository.exception.ComponentLookupException

Specified by:

getComponent in interface org.apache.maven.enforcer.rule.api.EnforcerRuleHelper

Throws:

org.codehaus.plexus.component.repository.exception.ComponentLookupException

getComponent

public Object getComponent(String theComponentKey)
                    throws org.codehaus.plexus.component.repository.exception.ComponentLookupException

Specified by:

getComponent in interface org.apache.maven.enforcer.rule.api.EnforcerRuleHelper

Throws:

org.codehaus.plexus.component.repository.exception.ComponentLookupException

getComponent

public Object getComponent(String theRole,
                  String theRoleHint)
                    throws org.codehaus.plexus.component.repository.exception.ComponentLookupException

Specified by:

getComponent in interface org.apache.maven.enforcer.rule.api.EnforcerRuleHelper

Throws:

org.codehaus.plexus.component.repository.exception.ComponentLookupException

getComponentList

public List getComponentList(String theRole)
                      throws org.codehaus.plexus.component.repository.exception.ComponentLookupException

Specified by:

getComponentList in interface org.apache.maven.enforcer.rule.api.EnforcerRuleHelper

Throws:

org.codehaus.plexus.component.repository.exception.ComponentLookupException

getComponentMap

public Map getComponentMap(String theRole)
                    throws org.codehaus.plexus.component.repository.exception.ComponentLookupException

Specified by:

getComponentMap in interface org.apache.maven.enforcer.rule.api.EnforcerRuleHelper

Throws:

org.codehaus.plexus.component.repository.exception.ComponentLookupException

getContainer

public org.codehaus.plexus.PlexusContainer getContainer()

Specified by:

getContainer in interface org.apache.maven.enforcer.rule.api.EnforcerRuleHelper