|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.codehaus.plexus.interpolation.RegexBasedInterpolator
public class RegexBasedInterpolator
Expansion of the original RegexBasedInterpolator, found in plexus-utils, this
interpolator provides options for setting custom prefix/suffix regex parts,
and includes a RecursionInterceptor
parameter in its interpolate(..)
call, to allow the detection of cyclical expression references.
Field Summary | |
---|---|
static java.lang.String |
DEFAULT_REGEXP
|
Constructor Summary | |
---|---|
RegexBasedInterpolator()
Setup a basic interpolator. |
|
RegexBasedInterpolator(boolean reusePatterns)
|
|
RegexBasedInterpolator(java.util.List valueSources)
Setup a basic interpolator with the specified list of value sources. |
|
RegexBasedInterpolator(java.lang.String startRegex,
java.lang.String endRegex)
Setup an interpolator with no value sources, and the specified regex pattern prefix and suffix in place of the default one. |
|
RegexBasedInterpolator(java.lang.String startRegex,
java.lang.String endRegex,
java.util.List valueSources)
Setup an interpolator with the specified value sources, and the specified regex pattern prefix and suffix in place of the default one. |
Method Summary | |
---|---|
void |
addPostProcessor(InterpolationPostProcessor postProcessor)
Add a new post-processor to handle final processing after recursively-interpolated value is determined. |
void |
addValueSource(ValueSource valueSource)
Add a new ValueSource to the stack used to resolve expressions
in this interpolator instance. |
void |
clearAnswers()
|
void |
clearFeedback()
Clear the feedback messages from previous interpolate(..) calls. |
java.util.List |
getFeedback()
Return any feedback messages and errors that were generated - but suppressed - during the interpolation process. |
java.lang.String |
interpolate(java.lang.String input)
See interpolate(String, String, RecursionInterceptor) . |
java.lang.String |
interpolate(java.lang.String input,
RecursionInterceptor recursionInterceptor)
See interpolate(String, String, RecursionInterceptor) . |
java.lang.String |
interpolate(java.lang.String input,
java.lang.String thisPrefixPattern)
See interpolate(String, String, RecursionInterceptor) . |
java.lang.String |
interpolate(java.lang.String input,
java.lang.String thisPrefixPattern,
RecursionInterceptor recursionInterceptor)
Attempt to resolve all expressions in the given input string, using the given pattern to first trim an optional prefix from each expression. |
boolean |
isCacheAnswers()
|
boolean |
isReusePatterns()
|
void |
removePostProcessor(InterpolationPostProcessor postProcessor)
Remove the given post-processor. |
void |
removeValuesSource(ValueSource valueSource)
Remove the specified ValueSource from the stack used to resolve
expressions in this interpolator instance. |
void |
setCacheAnswers(boolean cacheAnswers)
|
void |
setReusePatterns(boolean reusePatterns)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String DEFAULT_REGEXP
Constructor Detail |
---|
public RegexBasedInterpolator()
addValueSource(ValueSource)
at least once
if you use this constructor!
public RegexBasedInterpolator(boolean reusePatterns)
reusePatterns
- already compiled patterns will be reusedpublic RegexBasedInterpolator(java.lang.String startRegex, java.lang.String endRegex)
addValueSource(ValueSource)
at least once
if you use this constructor!
startRegex
- start of the regular expression to useendRegex
- end of the regular expression to usepublic RegexBasedInterpolator(java.util.List valueSources)
valueSources
- The list of value sources to usepublic RegexBasedInterpolator(java.lang.String startRegex, java.lang.String endRegex, java.util.List valueSources)
startRegex
- start of the regular expression to useendRegex
- end of the regular expression to usevalueSources
- The list of value sources to useMethod Detail |
---|
public void addValueSource(ValueSource valueSource)
ValueSource
to the stack used to resolve expressions
in this interpolator instance.
addValueSource
in interface Interpolator
public void removeValuesSource(ValueSource valueSource)
ValueSource
from the stack used to resolve
expressions in this interpolator instance.
removeValuesSource
in interface Interpolator
public void addPostProcessor(InterpolationPostProcessor postProcessor)
addPostProcessor
in interface Interpolator
public void removePostProcessor(InterpolationPostProcessor postProcessor)
removePostProcessor
in interface Interpolator
public java.lang.String interpolate(java.lang.String input, java.lang.String thisPrefixPattern, RecursionInterceptor recursionInterceptor) throws InterpolationException
interpolate
in interface Interpolator
input
- The input string to interpolatethisPrefixPattern
- An optional pattern that should be trimmed from
the start of any expressions found in the input.recursionInterceptor
- Used to protect the interpolation process
from expression cycles, and throw an
exception if one is detected.
InterpolationException
public java.util.List getFeedback()
getFeedback
in interface Interpolator
List
that may be interspersed with String
and
Throwable
instances.public void clearFeedback()
clearFeedback
in interface Interpolator
public java.lang.String interpolate(java.lang.String input, java.lang.String thisPrefixPattern) throws InterpolationException
interpolate(String, String, RecursionInterceptor)
.
SimpleRecursionInterceptor
instance for protection against expression cycles.
interpolate
in interface Interpolator
input
- The input string to interpolatethisPrefixPattern
- An optional pattern that should be trimmed from
the start of any expressions found in the input.
InterpolationException
public java.lang.String interpolate(java.lang.String input) throws InterpolationException
interpolate(String, String, RecursionInterceptor)
.
SimpleRecursionInterceptor
instance for protection against expression cycles. It also leaves empty the
expression prefix which would otherwise be trimmed from expressions. The
result is that any detected expression will be resolved as-is.
interpolate
in interface Interpolator
input
- The input string to interpolate
InterpolationException
public java.lang.String interpolate(java.lang.String input, RecursionInterceptor recursionInterceptor) throws InterpolationException
interpolate(String, String, RecursionInterceptor)
.
interpolate
in interface Interpolator
input
- The input string to interpolaterecursionInterceptor
- Used to protect the interpolation process
from expression cycles, and throw an
exception if one is detected.
InterpolationException
public boolean isReusePatterns()
public void setReusePatterns(boolean reusePatterns)
public boolean isCacheAnswers()
isCacheAnswers
in interface Interpolator
public void setCacheAnswers(boolean cacheAnswers)
setCacheAnswers
in interface Interpolator
public void clearAnswers()
clearAnswers
in interface Interpolator
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |