Class DefaultEnforcementRuleHelper
java.lang.Object
org.apache.maven.plugins.enforcer.internal.DefaultEnforcementRuleHelper
- All Implemented Interfaces:
EnforcerRuleHelper
,org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator
Default implementation of the EnforcementRuleHelper interface. This is used to help retrieve information from the
session and provide useful elements like the log.
- Author:
- Brian Fox
-
Constructor Summary
ConstructorDescriptionDefaultEnforcementRuleHelper
(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
Modifier and TypeMethodDescriptionalignToBaseDirectory
(File theFile) Gets a cached value, or uses the provided producer to compute it.<T> T
getComponent
(Class<T> clazz) Gets the component.<T> T
getComponent
(Class<T> clazz, String roleHint) Gets the component.getComponent
(String theComponentKey) Gets the component.getComponent
(String theRole, String theRoleHint) Gets the component.getComponentList
(String theRole) Gets the component list.getComponentMap
(String theRole) Gets the component map.org.codehaus.plexus.PlexusContainer
Gets the container.org.apache.maven.plugin.logging.Log
getLog()
Gets the log.
-
Constructor Details
-
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 sessionevaluator
- the evaluatorlog
- the logcontainer
- the container
-
-
Method Details
-
getLog
Description copied from interface:EnforcerRuleHelper
Gets the log.- Specified by:
getLog
in interfaceEnforcerRuleHelper
- Returns:
- the log
-
alignToBaseDirectory
- Specified by:
alignToBaseDirectory
in interfaceorg.codehaus.plexus.component.configurator.expression.ExpressionEvaluator
-
evaluate
public Object evaluate(String theExpression) throws org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException - Specified by:
evaluate
in interfaceorg.codehaus.plexus.component.configurator.expression.ExpressionEvaluator
- Throws:
org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException
-
getComponent
public <T> T getComponent(Class<T> clazz) throws org.codehaus.plexus.component.repository.exception.ComponentLookupException Description copied from interface:EnforcerRuleHelper
Gets the component.- Specified by:
getComponent
in interfaceEnforcerRuleHelper
- Type Parameters:
T
- a class type- Parameters:
clazz
- the clazz- Returns:
- the component
- Throws:
org.codehaus.plexus.component.repository.exception.ComponentLookupException
- the component lookup exception
-
getComponent
public Object getComponent(String theComponentKey) throws org.codehaus.plexus.component.repository.exception.ComponentLookupException Description copied from interface:EnforcerRuleHelper
Gets the component.- Specified by:
getComponent
in interfaceEnforcerRuleHelper
- Parameters:
theComponentKey
- the component key- Returns:
- the component
- Throws:
org.codehaus.plexus.component.repository.exception.ComponentLookupException
- the component lookup exception
-
getComponent
public Object getComponent(String theRole, String theRoleHint) throws org.codehaus.plexus.component.repository.exception.ComponentLookupException Description copied from interface:EnforcerRuleHelper
Gets the component.- Specified by:
getComponent
in interfaceEnforcerRuleHelper
- Parameters:
theRole
- the roletheRoleHint
- the role hint- Returns:
- the component
- Throws:
org.codehaus.plexus.component.repository.exception.ComponentLookupException
- the component lookup exception
-
getComponentList
public List<Object> getComponentList(String theRole) throws org.codehaus.plexus.component.repository.exception.ComponentLookupException Description copied from interface:EnforcerRuleHelper
Gets the component list.- Specified by:
getComponentList
in interfaceEnforcerRuleHelper
- Parameters:
theRole
- the role- Returns:
- the component list
- Throws:
org.codehaus.plexus.component.repository.exception.ComponentLookupException
- the component lookup exception
-
getComponentMap
public Map<String,Object> getComponentMap(String theRole) throws org.codehaus.plexus.component.repository.exception.ComponentLookupException Description copied from interface:EnforcerRuleHelper
Gets the component map.- Specified by:
getComponentMap
in interfaceEnforcerRuleHelper
- Parameters:
theRole
- the role- Returns:
- the component map
- Throws:
org.codehaus.plexus.component.repository.exception.ComponentLookupException
- the component lookup exception
-
getComponent
public <T> T getComponent(Class<T> clazz, String roleHint) throws org.codehaus.plexus.component.repository.exception.ComponentLookupException Description copied from interface:EnforcerRuleHelper
Gets the component.- Specified by:
getComponent
in interfaceEnforcerRuleHelper
- Type Parameters:
T
- a class type- Parameters:
clazz
- the clazzroleHint
- the role hint- Returns:
- the component
- Throws:
org.codehaus.plexus.component.repository.exception.ComponentLookupException
- the component lookup exception
-
getContainer
Description copied from interface:EnforcerRuleHelper
Gets the container.- Specified by:
getContainer
in interfaceEnforcerRuleHelper
- Returns:
- the container
-
getCache
Description copied from interface:EnforcerRuleHelper
Gets a cached value, or uses the provided producer to compute it.- Specified by:
getCache
in interfaceEnforcerRuleHelper
- Parameters:
key
- a key to identify the value storedproducer
- a supplier for the value if it's not already present- Returns:
- a previously-cached or freshly-computed value
-