Class DefaultEnforcementRuleHelper

  • All Implemented Interfaces:
    EnforcerRuleHelper, org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator

    public class DefaultEnforcementRuleHelper
    extends java.lang.Object
    implements EnforcerRuleHelper
    Default implementation of the EnforcementRuleHelper interface. This is used to help retrieve information from the session and provide useful elements like the log.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private org.codehaus.plexus.PlexusContainer container
      The container.
      private org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator evaluator
      The evaluator.
      private org.apache.maven.plugin.logging.Log log
      The log.
    • Constructor Summary

      Constructors 
      Constructor 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

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.io.File alignToBaseDirectory​(java.io.File theFile)  
      java.lang.Object evaluate​(java.lang.String theExpression)  
      <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 theComponentKey)
      Gets the component.
      java.lang.Object getComponent​(java.lang.String theRole, java.lang.String theRoleHint)
      Gets the component.
      java.util.List<java.lang.Object> getComponentList​(java.lang.String theRole)
      Gets the component list.
      java.util.Map<java.lang.String,​java.lang.Object> getComponentMap​(java.lang.String theRole)
      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 class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • log

        private org.apache.maven.plugin.logging.Log log
        The log.
      • evaluator

        private org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator evaluator
        The evaluator.
      • container

        private org.codehaus.plexus.PlexusContainer container
        The container.
    • 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

      • alignToBaseDirectory

        public java.io.File alignToBaseDirectory​(java.io.File theFile)
        Specified by:
        alignToBaseDirectory in interface org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator
      • evaluate

        public java.lang.Object evaluate​(java.lang.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 <T> T getComponent​(java.lang.Class<T> clazz)
                           throws org.codehaus.plexus.component.repository.exception.ComponentLookupException
        Description copied from interface: EnforcerRuleHelper
        Gets the component.
        Specified by:
        getComponent in interface EnforcerRuleHelper
        Parameters:
        clazz - the clazz
        Returns:
        the component
        Throws:
        org.codehaus.plexus.component.repository.exception.ComponentLookupException - the component lookup exception
      • getComponent

        public java.lang.Object getComponent​(java.lang.String theComponentKey)
                                      throws org.codehaus.plexus.component.repository.exception.ComponentLookupException
        Description copied from interface: EnforcerRuleHelper
        Gets the component.
        Specified by:
        getComponent in interface EnforcerRuleHelper
        Parameters:
        theComponentKey - the component key
        Returns:
        the component
        Throws:
        org.codehaus.plexus.component.repository.exception.ComponentLookupException - the component lookup exception
      • getComponent

        public java.lang.Object getComponent​(java.lang.String theRole,
                                             java.lang.String theRoleHint)
                                      throws org.codehaus.plexus.component.repository.exception.ComponentLookupException
        Description copied from interface: EnforcerRuleHelper
        Gets the component.
        Specified by:
        getComponent in interface EnforcerRuleHelper
        Parameters:
        theRole - the role
        theRoleHint - the role hint
        Returns:
        the component
        Throws:
        org.codehaus.plexus.component.repository.exception.ComponentLookupException - the component lookup exception
      • getComponentList

        public java.util.List<java.lang.Object> getComponentList​(java.lang.String theRole)
                                                          throws org.codehaus.plexus.component.repository.exception.ComponentLookupException
        Description copied from interface: EnforcerRuleHelper
        Gets the component list.
        Specified by:
        getComponentList in interface EnforcerRuleHelper
        Parameters:
        theRole - the role
        Returns:
        the component list
        Throws:
        org.codehaus.plexus.component.repository.exception.ComponentLookupException - the component lookup exception
      • getComponentMap

        public java.util.Map<java.lang.String,​java.lang.Object> getComponentMap​(java.lang.String theRole)
                                                                               throws org.codehaus.plexus.component.repository.exception.ComponentLookupException
        Description copied from interface: EnforcerRuleHelper
        Gets the component map.
        Specified by:
        getComponentMap in interface EnforcerRuleHelper
        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​(java.lang.Class<T> clazz,
                                  java.lang.String roleHint)
                           throws org.codehaus.plexus.component.repository.exception.ComponentLookupException
        Description copied from interface: EnforcerRuleHelper
        Gets the component.
        Specified by:
        getComponent in interface EnforcerRuleHelper
        Parameters:
        clazz - the clazz
        roleHint - the role hint
        Returns:
        the component
        Throws:
        org.codehaus.plexus.component.repository.exception.ComponentLookupException - the component lookup exception