Package org.apache.maven.enforcer.rule.api

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 Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      <T> T getComponent​(java.lang.Class<T> clazz)
      Gets the component.
      <T> T getComponent​(java.lang.Class<T> clazz, java.lang.String roleHint)
      Gets the component.
      java.lang.Object getComponent​(java.lang.String componentKey)
      Gets the component.
      java.lang.Object getComponent​(java.lang.String role, java.lang.String roleHint)
      Gets the component.
      java.util.List<?> getComponentList​(java.lang.String role)
      Gets the component list.
      java.util.Map<java.lang.String,​?> getComponentMap​(java.lang.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
<T> T getComponent​(java.lang.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
java.lang.Object getComponent​(java.lang.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

        java.lang.Object getComponent​(java.lang.String role,
                              java.lang.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​(java.lang.Class<T> clazz,
                   java.lang.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

        java.util.Map<java.lang.String,​?> getComponentMap​(java.lang.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

        java.util.List<?> getComponentList​(java.lang.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