org.codehaus.plexus.interpolation.object

Interface ObjectInterpolator

public interface ObjectInterpolator

Traverses an object graph and uses an Interpolator instance to resolve any String values in the graph.

Author: jdcasey

Method Summary
ListgetWarnings()
Retrieve the List of warnings (ObjectInterpolationWarning instances) generated during the last interpolation execution.
booleanhasWarnings()
Returns true if the last interpolation execution generated warnings.
voidinterpolate(Object target, Interpolator interpolator)
Traverse the object graph from the given starting point and interpolate any Strings found in that graph using the given Interpolator.
voidinterpolate(Object target, Interpolator interpolator, RecursionInterceptor recursionInterceptor)
Traverse the object graph from the given starting point and interpolate any Strings found in that graph using the given Interpolator.

Method Detail

getWarnings

public List getWarnings()
Retrieve the List of warnings (ObjectInterpolationWarning instances) generated during the last interpolation execution.

hasWarnings

public boolean hasWarnings()
Returns true if the last interpolation execution generated warnings.

interpolate

public void interpolate(Object target, Interpolator interpolator)
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.

interpolate

public void interpolate(Object target, Interpolator interpolator, RecursionInterceptor recursionInterceptor)
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

Copyright © 2001-2009 Codehaus. All Rights Reserved.