Package org.codehaus.plexus.interpolation.object

Interface ObjectInterpolator

All Known Implementing Classes:
FieldBasedObjectInterpolator
public interface ObjectInterpolator
Traverses an object graph and uses an Interpolator instance to resolve any String values in the graph.
Author:
jdcasey

  • Method Details

    • interpolate

      void interpolate(Object target, BasicInterpolator interpolator) throws InterpolationException
      Traverse the object graph from the given starting point and interpolate any Strings found in that graph using the given Interpolator.
      Parameters:
      target - The starting point of the object graph to traverse
      interpolator - The Interpolator used to resolve any Strings encountered during traversal.
      Throws:
      InterpolationException - in case of an error.

    • interpolate

      void interpolate(Object target, BasicInterpolator interpolator, RecursionInterceptor recursionInterceptor) throws InterpolationException
      Traverse the object graph from the given starting point and interpolate any Strings found in that graph using the given Interpolator.
      Parameters:
      target - The starting point of the object graph to traverse
      interpolator - The Interpolator used to resolve any Strings encountered during traversal.
      recursionInterceptor - The RecursionInterceptor used to detect cyclical expressions in the graph
      Throws:
      InterpolationException - in case of an error.

    • hasWarnings

      boolean hasWarnings()
      Returns true if the last interpolation execution generated warnings.
      Returns:
      true/false.

    • getWarnings

      List getWarnings()
      Retrieve the List of warnings (ObjectInterpolationWarning instances) generated during the last interpolation execution.
      Returns:
      The list of warnings.