/usr/share/doc/libplexus-interpolation-java/api/org/codehaus/plexus/interpolation/AbstractFunctionValueSourceWrapper.html is in libplexus-interpolation-java-doc 1.24-1.
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 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AbstractFunctionValueSourceWrapper (Plexus Interpolation API 1.24 API)</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AbstractFunctionValueSourceWrapper (Plexus Interpolation API 1.24 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":10,"i2":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/AbstractFunctionValueSourceWrapper.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/codehaus/plexus/interpolation/AbstractDelegatingValueSource.html" title="class in org.codehaus.plexus.interpolation"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/codehaus/plexus/interpolation/AbstractValueSource.html" title="class in org.codehaus.plexus.interpolation"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/codehaus/plexus/interpolation/AbstractFunctionValueSourceWrapper.html" target="_top">Frames</a></li>
<li><a href="AbstractFunctionValueSourceWrapper.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.codehaus.plexus.interpolation</div>
<h2 title="Class AbstractFunctionValueSourceWrapper" class="title">Class AbstractFunctionValueSourceWrapper</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.codehaus.plexus.interpolation.AbstractFunctionValueSourceWrapper</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../org/codehaus/plexus/interpolation/ValueSource.html" title="interface in org.codehaus.plexus.interpolation">ValueSource</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">AbstractFunctionValueSourceWrapper</span>
extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../../org/codehaus/plexus/interpolation/ValueSource.html" title="interface in org.codehaus.plexus.interpolation">ValueSource</a></pre>
<div class="block"><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.
When an expression is resolved, this wrapped source is first used to retrieve
the expression's actual value; then, the last expression processed by this
source is retrieved, and the two are passed into the abstract method
<a href="../../../../org/codehaus/plexus/interpolation/AbstractFunctionValueSourceWrapper.html#executeFunction-java.lang.String-java.lang.Object-"><code>executeFunction(String, Object)</code></a>
together. The result of this is returned as the resolved value for the second
expression.
<br/>
This allows the first expression to be a function name that modifies the
value of the second expression, which is resolved from the wrapped value
source.</div>
<dl>
<dt><span class="simpleTagLabel">Version:</span></dt>
<dd>$Id$</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/codehaus/plexus/interpolation/AbstractFunctionValueSourceWrapper.html#AbstractFunctionValueSourceWrapper-org.codehaus.plexus.interpolation.ValueSource-">AbstractFunctionValueSourceWrapper</a></span>(<a href="../../../../org/codehaus/plexus/interpolation/ValueSource.html" title="interface in org.codehaus.plexus.interpolation">ValueSource</a> valueSource)</code>
<div class="block">Construct a new function value source instance, using the supplied <a href="../../../../org/codehaus/plexus/interpolation/ValueSource.html" title="interface in org.codehaus.plexus.interpolation"><code>ValueSource</code></a>
to retrieve the input values for the function(s) this class implements.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected abstract <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/codehaus/plexus/interpolation/AbstractFunctionValueSourceWrapper.html#executeFunction-java.lang.String-java.lang.Object-">executeFunction</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> expression,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</code>
<div class="block">Execute the function referenced in the last-processed expression using the
value resolved from the current expression (using the embedded <a href="../../../../org/codehaus/plexus/interpolation/ValueSource.html" title="interface in org.codehaus.plexus.interpolation"><code>ValueSource</code></a>).</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/codehaus/plexus/interpolation/AbstractFunctionValueSourceWrapper.html#getValue-java.lang.String-">getValue</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> expression)</code>
<div class="block">
Resolve the current expression using the embedded <a href="../../../../org/codehaus/plexus/interpolation/ValueSource.html" title="interface in org.codehaus.plexus.interpolation"><code>ValueSource</code></a>
Retrieve the last expression processed by this value source
Pass the last expression (which should be the function name), along
with the value for the current expression, into the
executeFunction(..) method
Return the result of the executeFunction(..) as the resolved value
for the current expression.
</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected <a href="../../../../org/codehaus/plexus/interpolation/ValueSource.html" title="interface in org.codehaus.plexus.interpolation">ValueSource</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/codehaus/plexus/interpolation/AbstractFunctionValueSourceWrapper.html#getValueSource--">getValueSource</a></span>()</code>
<div class="block">Retrieve the embedded value source.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.codehaus.plexus.interpolation.ValueSource">
<!-- -->
</a>
<h3>Methods inherited from interface org.codehaus.plexus.interpolation.<a href="../../../../org/codehaus/plexus/interpolation/ValueSource.html" title="interface in org.codehaus.plexus.interpolation">ValueSource</a></h3>
<code><a href="../../../../org/codehaus/plexus/interpolation/ValueSource.html#clearFeedback--">clearFeedback</a>, <a href="../../../../org/codehaus/plexus/interpolation/ValueSource.html#getFeedback--">getFeedback</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AbstractFunctionValueSourceWrapper-org.codehaus.plexus.interpolation.ValueSource-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractFunctionValueSourceWrapper</h4>
<pre>protected AbstractFunctionValueSourceWrapper(<a href="../../../../org/codehaus/plexus/interpolation/ValueSource.html" title="interface in org.codehaus.plexus.interpolation">ValueSource</a> valueSource)</pre>
<div class="block">Construct a new function value source instance, using the supplied <a href="../../../../org/codehaus/plexus/interpolation/ValueSource.html" title="interface in org.codehaus.plexus.interpolation"><code>ValueSource</code></a>
to retrieve the input values for the function(s) this class implements.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>valueSource</code> - The value source to wrap</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getValue-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getValue(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> expression)</pre>
<div class="block"><ol>
<li>Resolve the current expression using the embedded <a href="../../../../org/codehaus/plexus/interpolation/ValueSource.html" title="interface in org.codehaus.plexus.interpolation"><code>ValueSource</code></a></li>
<li>Retrieve the last expression processed by this value source</li>
<li>Pass the last expression (which should be the function name), along
with the value for the current expression, into the
executeFunction(..) method</li>
<li>Return the result of the executeFunction(..) as the resolved value
for the current expression.</li>
</ol></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/codehaus/plexus/interpolation/ValueSource.html#getValue-java.lang.String-">getValue</a></code> in interface <code><a href="../../../../org/codehaus/plexus/interpolation/ValueSource.html" title="interface in org.codehaus.plexus.interpolation">ValueSource</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value related to the expression, or null if not found.</dd>
</dl>
</li>
</ul>
<a name="getValueSource--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValueSource</h4>
<pre>protected <a href="../../../../org/codehaus/plexus/interpolation/ValueSource.html" title="interface in org.codehaus.plexus.interpolation">ValueSource</a> getValueSource()</pre>
<div class="block">Retrieve the embedded value source.</div>
</li>
</ul>
<a name="executeFunction-java.lang.String-java.lang.Object-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>executeFunction</h4>
<pre>protected abstract <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> executeFunction(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> expression,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</pre>
<div class="block">Execute the function referenced in the last-processed expression using the
value resolved from the current expression (using the embedded <a href="../../../../org/codehaus/plexus/interpolation/ValueSource.html" title="interface in org.codehaus.plexus.interpolation"><code>ValueSource</code></a>).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>expression</code> - The last expression to be processed by this value source.</dd>
<dd><code>value</code> - The value for the current expression, resolved by the embedded <a href="../../../../org/codehaus/plexus/interpolation/ValueSource.html" title="interface in org.codehaus.plexus.interpolation"><code>ValueSource</code></a></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The result of modifying the current expression's value using the function named by the last expression.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/AbstractFunctionValueSourceWrapper.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/codehaus/plexus/interpolation/AbstractDelegatingValueSource.html" title="class in org.codehaus.plexus.interpolation"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/codehaus/plexus/interpolation/AbstractValueSource.html" title="class in org.codehaus.plexus.interpolation"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/codehaus/plexus/interpolation/AbstractFunctionValueSourceWrapper.html" target="_top">Frames</a></li>
<li><a href="AbstractFunctionValueSourceWrapper.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2017. All rights reserved.</small></p>
</body>
</html>
|