/usr/share/doc/libplexus-interpolation-java/api/org/codehaus/plexus/interpolation/package-summary.html is in libplexus-interpolation-java-doc 1.11-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_23) on Sun Aug 28 20:14:50 UTC 2011 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
org.codehaus.plexus.interpolation (Plexus Interpolation API 1.11 API)
</TITLE>
<META NAME="date" CONTENT="2011-08-28">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.codehaus.plexus.interpolation (Plexus Interpolation API 1.11 API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
PREV PACKAGE
<A HREF="../../../../org/codehaus/plexus/interpolation/object/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/codehaus/plexus/interpolation/package-summary.html" target="_top"><B>FRAMES</B></A>
<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<H2>
Package org.codehaus.plexus.interpolation
</H2>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Interface Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/codehaus/plexus/interpolation/FeedbackEnabledValueSource.html" title="interface in org.codehaus.plexus.interpolation">FeedbackEnabledValueSource</A></B></TD>
<TD><B>Deprecated.</B> <I>Rolled into <A HREF="../../../../org/codehaus/plexus/interpolation/ValueSource.html" title="interface in org.codehaus.plexus.interpolation"><CODE>ValueSource</CODE></A> now.</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/codehaus/plexus/interpolation/InterpolationPostProcessor.html" title="interface in org.codehaus.plexus.interpolation">InterpolationPostProcessor</A></B></TD>
<TD>Used to allow full recursion of value interpolation before applying some rule
to the result.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/codehaus/plexus/interpolation/Interpolator.html" title="interface in org.codehaus.plexus.interpolation">Interpolator</A></B></TD>
<TD>Interpolator interface.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/codehaus/plexus/interpolation/QueryEnabledValueSource.html" title="interface in org.codehaus.plexus.interpolation">QueryEnabledValueSource</A></B></TD>
<TD>Tracks the most recent expression processed by this value source implementation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/codehaus/plexus/interpolation/RecursionInterceptor.html" title="interface in org.codehaus.plexus.interpolation">RecursionInterceptor</A></B></TD>
<TD>Logs expressions before resolution is attempted, and clears them
after resolution is complete (or, fails all strategies).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/codehaus/plexus/interpolation/ValueSource.html" title="interface in org.codehaus.plexus.interpolation">ValueSource</A></B></TD>
<TD>Supplies one strategy for resolving a value for an interpolation expression.</TD>
</TR>
</TABLE>
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/codehaus/plexus/interpolation/AbstractDelegatingValueSource.html" title="class in org.codehaus.plexus.interpolation">AbstractDelegatingValueSource</A></B></TD>
<TD> </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/codehaus/plexus/interpolation/AbstractFunctionValueSourceWrapper.html" title="class in org.codehaus.plexus.interpolation">AbstractFunctionValueSourceWrapper</A></B></TD>
<TD><A HREF="../../../../org/codehaus/plexus/interpolation/ValueSource.html" title="interface in org.codehaus.plexus.interpolation"><CODE>ValueSource</CODE></A> abstract implementation that wraps another value source.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/codehaus/plexus/interpolation/AbstractValueSource.html" title="class in org.codehaus.plexus.interpolation">AbstractValueSource</A></B></TD>
<TD> </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/codehaus/plexus/interpolation/EnvarBasedValueSource.html" title="class in org.codehaus.plexus.interpolation">EnvarBasedValueSource</A></B></TD>
<TD><A HREF="../../../../org/codehaus/plexus/interpolation/ValueSource.html" title="interface in org.codehaus.plexus.interpolation"><CODE>ValueSource</CODE></A> which resolves expressions against the environment variables
available from the underlying operating system (and possibly, the shell environment
that created the present Java process).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/codehaus/plexus/interpolation/InterpolatorFilterReader.html" title="class in org.codehaus.plexus.interpolation">InterpolatorFilterReader</A></B></TD>
<TD>A FilterReader implementation, that works with Interpolator interface instead of it's own interpolation
implementation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/codehaus/plexus/interpolation/MapBasedValueSource.html" title="class in org.codehaus.plexus.interpolation">MapBasedValueSource</A></B></TD>
<TD>Wraps a Map, and looks up the whole expression as a single key, returning the
value mapped to it.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/codehaus/plexus/interpolation/ObjectBasedValueSource.html" title="class in org.codehaus.plexus.interpolation">ObjectBasedValueSource</A></B></TD>
<TD>Wraps an object, providing reflective access to the object graph of which the
supplied object is the root.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/codehaus/plexus/interpolation/PrefixAwareRecursionInterceptor.html" title="class in org.codehaus.plexus.interpolation">PrefixAwareRecursionInterceptor</A></B></TD>
<TD><A HREF="../../../../org/codehaus/plexus/interpolation/RecursionInterceptor.html" title="interface in org.codehaus.plexus.interpolation"><CODE>RecursionInterceptor</CODE></A> implementation that provides support for expressions
with multiple synonyms, such as project.build.directory == pom.build.directory ==
build.directory in Maven's POM.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/codehaus/plexus/interpolation/PrefixedObjectValueSource.html" title="class in org.codehaus.plexus.interpolation">PrefixedObjectValueSource</A></B></TD>
<TD>Wraps an arbitrary object with an <A HREF="../../../../org/codehaus/plexus/interpolation/ObjectBasedValueSource.html" title="class in org.codehaus.plexus.interpolation"><CODE>ObjectBasedValueSource</CODE></A> instance, then
wraps that source with a <A HREF="../../../../org/codehaus/plexus/interpolation/PrefixedValueSourceWrapper.html" title="class in org.codehaus.plexus.interpolation"><CODE>PrefixedValueSourceWrapper</CODE></A> instance, to which
this class delegates all of its calls.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/codehaus/plexus/interpolation/PrefixedPropertiesValueSource.html" title="class in org.codehaus.plexus.interpolation">PrefixedPropertiesValueSource</A></B></TD>
<TD>Legacy support.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/codehaus/plexus/interpolation/PrefixedValueSourceWrapper.html" title="class in org.codehaus.plexus.interpolation">PrefixedValueSourceWrapper</A></B></TD>
<TD><A HREF="../../../../org/codehaus/plexus/interpolation/ValueSource.html" title="interface in org.codehaus.plexus.interpolation"><CODE>ValueSource</CODE></A> implementation which simply wraps another value source,
and trims any of a set of possible expression prefixes before delegating the
modified expression to be resolved by the real value source.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/codehaus/plexus/interpolation/PropertiesBasedValueSource.html" title="class in org.codehaus.plexus.interpolation">PropertiesBasedValueSource</A></B></TD>
<TD><A HREF="../../../../org/codehaus/plexus/interpolation/ValueSource.html" title="interface in org.codehaus.plexus.interpolation"><CODE>ValueSource</CODE></A> implementation that wraps a <CODE>Properties</CODE> instance,
and does a simple lookup of the entire expression string as the parameter for
<CODE>Properties.getProperty(String)</CODE>, returning the result as the resolved
value.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/codehaus/plexus/interpolation/RegexBasedInterpolator.html" title="class in org.codehaus.plexus.interpolation">RegexBasedInterpolator</A></B></TD>
<TD>Expansion of the original RegexBasedInterpolator, found in plexus-utils, this
interpolator provides options for setting custom prefix/suffix regex parts,
and includes a <A HREF="../../../../org/codehaus/plexus/interpolation/RecursionInterceptor.html" title="interface in org.codehaus.plexus.interpolation"><CODE>RecursionInterceptor</CODE></A> parameter in its interpolate(..)
call, to allow the detection of cyclical expression references.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/codehaus/plexus/interpolation/SimpleRecursionInterceptor.html" title="class in org.codehaus.plexus.interpolation">SimpleRecursionInterceptor</A></B></TD>
<TD>Simplest implementation of a <A HREF="../../../../org/codehaus/plexus/interpolation/RecursionInterceptor.html" title="interface in org.codehaus.plexus.interpolation"><CODE>RecursionInterceptor</CODE></A>, which checks whether
the existing interpolation effort is already attempting to resolve an exact
expression, but has not finished.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/codehaus/plexus/interpolation/StringSearchInterpolator.html" title="class in org.codehaus.plexus.interpolation">StringSearchInterpolator</A></B></TD>
<TD> </TD>
</TR>
</TABLE>
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Exception Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/codehaus/plexus/interpolation/InterpolationCycleException.html" title="class in org.codehaus.plexus.interpolation">InterpolationCycleException</A></B></TD>
<TD> </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/codehaus/plexus/interpolation/InterpolationException.html" title="class in org.codehaus.plexus.interpolation">InterpolationException</A></B></TD>
<TD>Signals an unrecoverable error in the process of interpolating a string, such
as the detection of an expression cycle.</TD>
</TR>
</TABLE>
<P>
<DL>
</DL>
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
PREV PACKAGE
<A HREF="../../../../org/codehaus/plexus/interpolation/object/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/codehaus/plexus/interpolation/package-summary.html" target="_top"><B>FRAMES</B></A>
<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright © 2011. All Rights Reserved.
</BODY>
</HTML>
|