| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Function (Apache JMeter dist API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.jmeter.functions, interface: Function"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <div class="about-language"><b>Apache JMeter</b></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.jmeter.functions</a></div> |
| <h1 title="Interface Function" class="title">Interface Function</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</a></code>, <code><a href="BeanShell.html" title="class in org.apache.jmeter.functions">BeanShell</a></code>, <code><a href="ChangeCase.html" title="class in org.apache.jmeter.functions">ChangeCase</a></code>, <code><a href="CharFunction.html" title="class in org.apache.jmeter.functions">CharFunction</a></code>, <code><a href="../engine/util/CompoundVariable.html" title="class in org.apache.jmeter.engine.util">CompoundVariable</a></code>, <code><a href="CSVRead.html" title="class in org.apache.jmeter.functions">CSVRead</a></code>, <code><a href="DateTimeConvertFunction.html" title="class in org.apache.jmeter.functions">DateTimeConvertFunction</a></code>, <code><a href="DigestEncodeFunction.html" title="class in org.apache.jmeter.functions">DigestEncodeFunction</a></code>, <code><a href="EscapeHtml.html" title="class in org.apache.jmeter.functions">EscapeHtml</a></code>, <code><a href="EscapeOroRegexpChars.html" title="class in org.apache.jmeter.functions">EscapeOroRegexpChars</a></code>, <code><a href="EscapeXml.html" title="class in org.apache.jmeter.functions">EscapeXml</a></code>, <code><a href="EvalFunction.html" title="class in org.apache.jmeter.functions">EvalFunction</a></code>, <code><a href="EvalVarFunction.html" title="class in org.apache.jmeter.functions">EvalVarFunction</a></code>, <code><a href="FileToString.html" title="class in org.apache.jmeter.functions">FileToString</a></code>, <code><a href="Groovy.html" title="class in org.apache.jmeter.functions">Groovy</a></code>, <code><a href="IntSum.html" title="class in org.apache.jmeter.functions">IntSum</a></code>, <code><a href="IsPropDefined.html" title="class in org.apache.jmeter.functions">IsPropDefined</a></code>, <code><a href="IsVarDefined.html" title="class in org.apache.jmeter.functions">IsVarDefined</a></code>, <code><a href="IterationCounter.html" title="class in org.apache.jmeter.functions">IterationCounter</a></code>, <code><a href="JavaScript.html" title="class in org.apache.jmeter.functions">JavaScript</a></code>, <code><a href="Jexl2Function.html" title="class in org.apache.jmeter.functions">Jexl2Function</a></code>, <code><a href="Jexl3Function.html" title="class in org.apache.jmeter.functions">Jexl3Function</a></code>, <code><a href="LogFunction.html" title="class in org.apache.jmeter.functions">LogFunction</a></code>, <code><a href="LogFunction2.html" title="class in org.apache.jmeter.functions">LogFunction2</a></code>, <code><a href="LongSum.html" title="class in org.apache.jmeter.functions">LongSum</a></code>, <code><a href="MachineIP.html" title="class in org.apache.jmeter.functions">MachineIP</a></code>, <code><a href="MachineName.html" title="class in org.apache.jmeter.functions">MachineName</a></code>, <code><a href="Property.html" title="class in org.apache.jmeter.functions">Property</a></code>, <code><a href="Property2.html" title="class in org.apache.jmeter.functions">Property2</a></code>, <code><a href="Random.html" title="class in org.apache.jmeter.functions">Random</a></code>, <code><a href="RandomDate.html" title="class in org.apache.jmeter.functions">RandomDate</a></code>, <code><a href="RandomFromMultipleVars.html" title="class in org.apache.jmeter.functions">RandomFromMultipleVars</a></code>, <code><a href="RandomString.html" title="class in org.apache.jmeter.functions">RandomString</a></code>, <code><a href="RegexFunction.html" title="class in org.apache.jmeter.functions">RegexFunction</a></code>, <code><a href="SamplerName.html" title="class in org.apache.jmeter.functions">SamplerName</a></code>, <code><a href="SetProperty.html" title="class in org.apache.jmeter.functions">SetProperty</a></code>, <code><a href="SplitFunction.html" title="class in org.apache.jmeter.functions">SplitFunction</a></code>, <code><a href="StringFromFile.html" title="class in org.apache.jmeter.functions">StringFromFile</a></code>, <code><a href="StringToFile.html" title="class in org.apache.jmeter.functions">StringToFile</a></code>, <code><a href="TestPlanName.html" title="class in org.apache.jmeter.functions">TestPlanName</a></code>, <code><a href="ThreadGroupName.html" title="class in org.apache.jmeter.functions">ThreadGroupName</a></code>, <code><a href="ThreadNumber.html" title="class in org.apache.jmeter.functions">ThreadNumber</a></code>, <code><a href="TimeFunction.html" title="class in org.apache.jmeter.functions">TimeFunction</a></code>, <code><a href="TimeShift.html" title="class in org.apache.jmeter.functions">TimeShift</a></code>, <code><a href="UnEscape.html" title="class in org.apache.jmeter.functions">UnEscape</a></code>, <code><a href="UnEscapeHtml.html" title="class in org.apache.jmeter.functions">UnEscapeHtml</a></code>, <code><a href="UrlDecode.html" title="class in org.apache.jmeter.functions">UrlDecode</a></code>, <code><a href="UrlEncode.html" title="class in org.apache.jmeter.functions">UrlEncode</a></code>, <code><a href="Uuid.html" title="class in org.apache.jmeter.functions">Uuid</a></code>, <code><a href="Variable.html" title="class in org.apache.jmeter.functions">Variable</a></code>, <code><a href="XPath.html" title="class in org.apache.jmeter.functions">XPath</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Function</span></div> |
| <div class="block">Methods that a function must implement</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#execute(org.apache.jmeter.samplers.SampleResult,org.apache.jmeter.samplers.Sampler)" class="member-name-link">execute</a><wbr>(<a href="../samplers/SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a> previousResult, |
| <a href="../samplers/Sampler.html" title="interface in org.apache.jmeter.samplers">Sampler</a> currentSampler)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Given the previous SampleResult and the current Sampler, return a string |
| to use as a replacement value for the function call.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getArgumentDesc()" class="member-name-link">getArgumentDesc</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Return a list of strings briefly describing each parameter your function |
| takes.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getReferenceKey()" class="member-name-link">getReferenceKey</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Return the name of your function.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setParameters(java.util.Collection)" class="member-name-link">setParameters</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="../engine/util/CompoundVariable.html" title="class in org.apache.jmeter.engine.util">CompoundVariable</a>> parameters)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">A collection of the parameters used to configure your function.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="execute(org.apache.jmeter.samplers.SampleResult,org.apache.jmeter.samplers.Sampler)"> |
| <h3>execute</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">execute</span><wbr><span class="parameters">(<a href="../samplers/SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a> previousResult, |
| <a href="../samplers/Sampler.html" title="interface in org.apache.jmeter.samplers">Sampler</a> currentSampler)</span> |
| throws <span class="exceptions"><a href="InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</a></span></div> |
| <div class="block">Given the previous SampleResult and the current Sampler, return a string |
| to use as a replacement value for the function call. Assume |
| "setParameter" was previously called. |
| |
| <p>This method must be thread-safe - multiple threads will be using the same |
| object.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>previousResult</code> - The previous <a href="../samplers/SampleResult.html" title="class in org.apache.jmeter.samplers"><code>SampleResult</code></a></dd> |
| <dd><code>currentSampler</code> - The current <a href="../samplers/Sampler.html" title="interface in org.apache.jmeter.samplers"><code>Sampler</code></a></dd> |
| <dt>Returns:</dt> |
| <dd>The replacement value, which was generated by the function</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</a></code> - - when the variables for the function call can't be evaluated</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setParameters(java.util.Collection)"> |
| <h3>setParameters</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">setParameters</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="../engine/util/CompoundVariable.html" title="class in org.apache.jmeter.engine.util">CompoundVariable</a>> parameters)</span> |
| throws <span class="exceptions"><a href="InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</a></span></div> |
| <div class="block">A collection of the parameters used to configure your function. Each |
| parameter is a CompoundVariable and can be resolved by calling the |
| execute() method of the CompoundVariable (which should be done at |
| execution.)</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>parameters</code> - The parameters for the function call</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</a></code> - - when the variables for the function call can't be evaluated</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getReferenceKey()"> |
| <h3>getReferenceKey</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getReferenceKey</span>()</div> |
| <div class="block">Return the name of your function. Convention is to prepend "__" to the |
| name (ie "__regexFunction")</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>The name of the function</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getArgumentDesc()"> |
| <h3>getArgumentDesc</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">getArgumentDesc</span>()</div> |
| <div class="block">Return a list of strings briefly describing each parameter your function |
| takes. Please use JMeterUtils.getResString(resource_name) to grab a |
| resource string. Otherwise, your help text will be difficult to |
| internationalize. |
| |
| This list is not optional. If you don't wish to write help, you must at |
| least return a List containing the correct number of blank strings, one |
| for each argument.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>List with brief descriptions for each parameter the function takes</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 1998-2024 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
