Interface EnforcerRuleHelper

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.
  • Method Details

    • getLog

      @Nonnull org.apache.maven.plugin.logging.Log getLog()
      Gets the log.
      Returns:
      the log
    • getComponent

      @Nonnull <T> T getComponent(Class<T> 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
    • getComponent

      <T> T getComponent(Class<T> clazz, String roleHint) throws org.codehaus.plexus.component.repository.exception.ComponentLookupException
      Gets the component.
      Parameters:
      clazz - the clazz
      roleHint - the role hint
      Returns:
      the component
      Throws:
      org.codehaus.plexus.component.repository.exception.ComponentLookupException - the component lookup exception
    • getComponentMap

      Map<String,?> 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