Package org.apache.maven.plugins.enforcer.internal

Class DefaultEnforcementRuleHelper

java.lang.Object
org.apache.maven.plugins.enforcer.internal.DefaultEnforcementRuleHelper
All Implemented Interfaces:
EnforcerRuleHelper, org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator
public class DefaultEnforcementRuleHelper extends 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.
Author:
Brian Fox

  • 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 session
      evaluator - the evaluator
      log - the log
      container - the container

  • Method Details

    • getLog

      public org.apache.maven.plugin.logging.Log getLog()
      Description copied from interface: EnforcerRuleHelper
      Gets the log.
      Specified by:
      getLog in interface EnforcerRuleHelper
      Returns:
      the log

    • alignToBaseDirectory

      public File alignToBaseDirectory(File theFile)
      Specified by:
      alignToBaseDirectory in interface org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator

    • evaluate

      public Object evaluate(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(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
      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 interface EnforcerRuleHelper
      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 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 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 interface EnforcerRuleHelper
      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 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(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 interface EnforcerRuleHelper
      Type Parameters:
      T - a class type
      Parameters:
      clazz - the clazz
      roleHint - the role hint
      Returns:
      the component
      Throws:
      org.codehaus.plexus.component.repository.exception.ComponentLookupException - the component lookup exception

    • getContainer

      public org.codehaus.plexus.PlexusContainer getContainer()
      Description copied from interface: EnforcerRuleHelper
      Gets the container.
      Specified by:
      getContainer in interface EnforcerRuleHelper
      Returns:
      the container

    • getCache

      public Object getCache(String key, Supplier<?> producer)
      Description copied from interface: EnforcerRuleHelper
      Gets a cached value, or uses the provided producer to compute it.
      Specified by:
      getCache in interface EnforcerRuleHelper
      Parameters:
      key - a key to identify the value stored
      producer - a supplier for the value if it's not already present
      Returns:
      a previously-cached or freshly-computed value