EnforcerRuleHelper (Apache Maven Enforcer 1.4.1 API)

All Superinterfaces:

org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator

All Known Implementing Classes:

DefaultEnforcementRuleHelper
```
public interface EnforcerRuleHelper
extends org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator
```
This is the interface that all helpers will use. This provides access to the log, session and components to the rules.

Author:

Brian Fox

Method Summary

Methods
Modifier and Type	Method and Description
`Object`	`getComponent(Class clazz)` Gets the component.
`Object`	`getComponent(String componentKey)` Gets the component.
`Object`	`getComponent(String role, String roleHint)` Gets the component.
`List`	`getComponentList(String role)` Gets the component list.
`Map`	`getComponentMap(String role)` Gets the component map.
`org.codehaus.plexus.PlexusContainer`	`getContainer()` Gets the container.
`org.apache.maven.plugin.logging.Log`	`getLog()` Gets the log.

Methods inherited from interface org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator
alignToBaseDirectory, evaluate

- Method Detail
  - getLog
```
@Nonnull
org.apache.maven.plugin.logging.Log getLog()
```
    Gets the log.
    
    Returns:
    the log
  - getComponent
```
@Nonnull
Object getComponent(Class clazz)
                    throws org.codehaus.plexus.component.repository.exception.ComponentLookupException
```
    Gets the component.
    
    Parameters:
    clazz - the clazz
    
    Returns:
    the component
    
    Throws:
    
    org.codehaus.plexus.component.repository.exception.ComponentLookupException - the component lookup exception
  - getComponent
```
@Nonnull
Object getComponent(String componentKey)
                    throws org.codehaus.plexus.component.repository.exception.ComponentLookupException
```
    Gets the component.
    
    Parameters:
    componentKey - the component key
    
    Returns:
    the component
    
    Throws:
    
    org.codehaus.plexus.component.repository.exception.ComponentLookupException - the component lookup exception
  - getComponent
```
Object getComponent(String role,
                  String roleHint)
                    throws org.codehaus.plexus.component.repository.exception.ComponentLookupException
```
    Gets the component.
    
    Parameters:
    role - the role
    roleHint - the role hint
    
    Returns:
    the component
    
    Throws:
    
    org.codehaus.plexus.component.repository.exception.ComponentLookupException - the component lookup exception
  - getComponentMap
```
Map getComponentMap(String role)
                    throws org.codehaus.plexus.component.repository.exception.ComponentLookupException
```
    Gets the component map.
    
    Parameters:
    role - the role
    
    Returns:
    the component map
    
    Throws:
    
    org.codehaus.plexus.component.repository.exception.ComponentLookupException - the component lookup exception
  - getComponentList
```
List getComponentList(String role)
                      throws org.codehaus.plexus.component.repository.exception.ComponentLookupException
```
    Gets the component list.
    
    Parameters:
    role - the role
    
    Returns:
    the component list
    
    Throws:
    
    org.codehaus.plexus.component.repository.exception.ComponentLookupException - the component lookup exception
  - getContainer
```
org.codehaus.plexus.PlexusContainer getContainer()
```
    Gets the container.
    
    Returns:
    the container

Interface EnforcerRuleHelper

Method Summary

Methods inherited from interface org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator

Method Detail

getLog

getComponent

getComponent

getComponent

getComponentMap

getComponentList

getContainer