| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>JMeterContext (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.threads, class: JMeterContext"> |
| <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><a href="#nested-class-summary">Nested</a> | </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.threads</a></div> |
| <h1 title="Class JMeterContext" class="title">Class JMeterContext</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.jmeter.threads.JMeterContext</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">JMeterContext</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> |
| <div class="block">Holds context for a thread. |
| Generated by JMeterContextService. |
| <br> |
| The class is not thread-safe - it is only intended for use within a single thread.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static enum </code></div> |
| <div class="col-second even-row-color"><code><a href="JMeterContext.TestLogicalAction.html" class="type-name-link" title="enum in org.apache.jmeter.threads">JMeterContext.TestLogicalAction</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== 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-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated 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-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#cleanAfterSample()" class="member-name-link">cleanAfterSample</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Clean cached data after sample |
| Internally called by JMeter, never call it directly</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clear()" class="member-name-link">clear</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Internally called by JMeter, never call it directly</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../samplers/Sampler.html" title="interface in org.apache.jmeter.samplers">Sampler</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCurrentSampler()" class="member-name-link">getCurrentSampler</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../engine/StandardJMeterEngine.html" title="class in org.apache.jmeter.engine">StandardJMeterEngine</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEngine()" class="member-name-link">getEngine</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../samplers/SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPreviousResult()" class="member-name-link">getPreviousResult</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../samplers/Sampler.html" title="interface in org.apache.jmeter.samplers">Sampler</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPreviousSampler()" class="member-name-link">getPreviousSampler</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the previousSampler.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html" title="class or interface in java.util" class="external-link">Properties</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getProperties()" class="member-name-link">getProperties</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSamplerContext()" class="member-name-link">getSamplerContext</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sampler context is cleaned up as soon as Post-Processor have ended</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JMeterContext.TestLogicalAction.html" title="enum in org.apache.jmeter.threads">JMeterContext.TestLogicalAction</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTestLogicalAction()" class="member-name-link">getTestLogicalAction</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JMeterThread.html" title="class in org.apache.jmeter.threads">JMeterThread</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getThread()" class="member-name-link">getThread</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="AbstractThreadGroup.html" title="class in org.apache.jmeter.threads">AbstractThreadGroup</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getThreadGroup()" class="member-name-link">getThreadGroup</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getThreadNum()" class="member-name-link">getThreadNum</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JMeterVariables.html" title="class in org.apache.jmeter.threads">JMeterVariables</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getVariables()" class="member-name-link">getVariables</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gives access to the JMeter variables for the current thread.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isRecording()" class="member-name-link">isRecording</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#isRestartNextLoop()" class="member-name-link">isRestartNextLoop</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">use <a href="#isStartNextThreadLoop()"><code>isStartNextThreadLoop()</code></a></div> |
| </div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isSamplingStarted()" class="member-name-link">isSamplingStarted</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#isStartNextThreadLoop()" class="member-name-link">isStartNextThreadLoop</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">use <a href="#getTestLogicalAction()"><code>getTestLogicalAction()</code></a></div> |
| </div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setCurrentSampler(org.apache.jmeter.samplers.Sampler)" class="member-name-link">setCurrentSampler</a><wbr>(<a href="../samplers/Sampler.html" title="interface in org.apache.jmeter.samplers">Sampler</a> sampler)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Internally called by JMeter, never call it directly</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setEngine(org.apache.jmeter.engine.StandardJMeterEngine)" class="member-name-link">setEngine</a><wbr>(<a href="../engine/StandardJMeterEngine.html" title="class in org.apache.jmeter.engine">StandardJMeterEngine</a> engine)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Internally called by JMeter, never call it directly</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setPreviousResult(org.apache.jmeter.samplers.SampleResult)" class="member-name-link">setPreviousResult</a><wbr>(<a href="../samplers/SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a> result)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Internally called by JMeter, never call it directly</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setRecording(boolean)" class="member-name-link">setRecording</a><wbr>(boolean recording)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Internally called by JMeter, never call it directly</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setRestartNextLoop(boolean)" class="member-name-link">setRestartNextLoop</a><wbr>(boolean restartNextLoop)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">use <a href="#setStartNextThreadLoop(boolean)"><code>setStartNextThreadLoop(boolean)</code></a></div> |
| </div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSamplingStarted(boolean)" class="member-name-link">setSamplingStarted</a><wbr>(boolean b)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Internally called by JMeter, never call it directly</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setStartNextThreadLoop(boolean)" class="member-name-link">setStartNextThreadLoop</a><wbr>(boolean restartNextLoop)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">use <a href="#setTestLogicalAction(org.apache.jmeter.threads.JMeterContext.TestLogicalAction)"><code>setTestLogicalAction(TestLogicalAction)</code></a></div> |
| </div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setTestLogicalAction(org.apache.jmeter.threads.JMeterContext.TestLogicalAction)" class="member-name-link">setTestLogicalAction</a><wbr>(<a href="JMeterContext.TestLogicalAction.html" title="enum in org.apache.jmeter.threads">JMeterContext.TestLogicalAction</a> actionOnExecution)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setThread(org.apache.jmeter.threads.JMeterThread)" class="member-name-link">setThread</a><wbr>(<a href="JMeterThread.html" title="class in org.apache.jmeter.threads">JMeterThread</a> thread)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Internally called by JMeter, never call it directly</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setThreadGroup(org.apache.jmeter.threads.AbstractThreadGroup)" class="member-name-link">setThreadGroup</a><wbr>(<a href="AbstractThreadGroup.html" title="class in org.apache.jmeter.threads">AbstractThreadGroup</a> threadgrp)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Internally called by JMeter, never call it directly</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setThreadNum(int)" class="member-name-link">setThreadNum</a><wbr>(int threadNum)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Internally called by JMeter, never call it directly</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setVariables(org.apache.jmeter.threads.JMeterVariables)" class="member-name-link">setVariables</a><wbr>(<a href="JMeterVariables.html" title="class in org.apache.jmeter.threads">JMeterVariables</a> vars)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Internally called by JMeter, never call it directly</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></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="clear()"> |
| <h3>clear</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">clear</span>()</div> |
| <div class="block">Internally called by JMeter, never call it directly</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getVariables()"> |
| <h3>getVariables</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JMeterVariables.html" title="class in org.apache.jmeter.threads">JMeterVariables</a></span> <span class="element-name">getVariables</span>()</div> |
| <div class="block">Gives access to the JMeter variables for the current thread.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a pointer to the JMeter variables.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getProperties()"> |
| <h3>getProperties</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html" title="class or interface in java.util" class="external-link">Properties</a></span> <span class="element-name">getProperties</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a pointer to the JMeter Properties.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setVariables(org.apache.jmeter.threads.JMeterVariables)"> |
| <h3>setVariables</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setVariables</span><wbr><span class="parameters">(<a href="JMeterVariables.html" title="class in org.apache.jmeter.threads">JMeterVariables</a> vars)</span></div> |
| <div class="block">Internally called by JMeter, never call it directly</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>vars</code> - JMeterVariables</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPreviousResult()"> |
| <h3>getPreviousResult</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../samplers/SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a></span> <span class="element-name">getPreviousResult</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setPreviousResult(org.apache.jmeter.samplers.SampleResult)"> |
| <h3>setPreviousResult</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setPreviousResult</span><wbr><span class="parameters">(<a href="../samplers/SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</a> result)</span></div> |
| <div class="block">Internally called by JMeter, never call it directly</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>result</code> - SampleResult</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCurrentSampler()"> |
| <h3>getCurrentSampler</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../samplers/Sampler.html" title="interface in org.apache.jmeter.samplers">Sampler</a></span> <span class="element-name">getCurrentSampler</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setCurrentSampler(org.apache.jmeter.samplers.Sampler)"> |
| <h3>setCurrentSampler</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setCurrentSampler</span><wbr><span class="parameters">(<a href="../samplers/Sampler.html" title="interface in org.apache.jmeter.samplers">Sampler</a> sampler)</span></div> |
| <div class="block">Internally called by JMeter, never call it directly</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sampler</code> - Sampler</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPreviousSampler()"> |
| <h3>getPreviousSampler</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../samplers/Sampler.html" title="interface in org.apache.jmeter.samplers">Sampler</a></span> <span class="element-name">getPreviousSampler</span>()</div> |
| <div class="block">Returns the previousSampler.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Sampler</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getThreadNum()"> |
| <h3>getThreadNum</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getThreadNum</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the threadNum starting from zero (0)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setThreadNum(int)"> |
| <h3>setThreadNum</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setThreadNum</span><wbr><span class="parameters">(int threadNum)</span></div> |
| <div class="block">Internally called by JMeter, never call it directly</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>threadNum</code> - number of threads</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getThread()"> |
| <h3>getThread</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JMeterThread.html" title="class in org.apache.jmeter.threads">JMeterThread</a></span> <span class="element-name">getThread</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setThread(org.apache.jmeter.threads.JMeterThread)"> |
| <h3>setThread</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setThread</span><wbr><span class="parameters">(<a href="JMeterThread.html" title="class in org.apache.jmeter.threads">JMeterThread</a> thread)</span></div> |
| <div class="block">Internally called by JMeter, never call it directly</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>thread</code> - to use</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getThreadGroup()"> |
| <h3>getThreadGroup</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="AbstractThreadGroup.html" title="class in org.apache.jmeter.threads">AbstractThreadGroup</a></span> <span class="element-name">getThreadGroup</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setThreadGroup(org.apache.jmeter.threads.AbstractThreadGroup)"> |
| <h3>setThreadGroup</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setThreadGroup</span><wbr><span class="parameters">(<a href="AbstractThreadGroup.html" title="class in org.apache.jmeter.threads">AbstractThreadGroup</a> threadgrp)</span></div> |
| <div class="block">Internally called by JMeter, never call it directly</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>threadgrp</code> - ThreadGroup to use</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getEngine()"> |
| <h3>getEngine</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../engine/StandardJMeterEngine.html" title="class in org.apache.jmeter.engine">StandardJMeterEngine</a></span> <span class="element-name">getEngine</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setEngine(org.apache.jmeter.engine.StandardJMeterEngine)"> |
| <h3>setEngine</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setEngine</span><wbr><span class="parameters">(<a href="../engine/StandardJMeterEngine.html" title="class in org.apache.jmeter.engine">StandardJMeterEngine</a> engine)</span></div> |
| <div class="block">Internally called by JMeter, never call it directly</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>engine</code> - to use</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isSamplingStarted()"> |
| <h3>isSamplingStarted</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isSamplingStarted</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setSamplingStarted(boolean)"> |
| <h3>setSamplingStarted</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setSamplingStarted</span><wbr><span class="parameters">(boolean b)</span></div> |
| <div class="block">Internally called by JMeter, never call it directly</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>b</code> - flag whether sampling has started</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setTestLogicalAction(org.apache.jmeter.threads.JMeterContext.TestLogicalAction)"> |
| <h3>setTestLogicalAction</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setTestLogicalAction</span><wbr><span class="parameters">(<a href="JMeterContext.TestLogicalAction.html" title="enum in org.apache.jmeter.threads">JMeterContext.TestLogicalAction</a> actionOnExecution)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>actionOnExecution</code> - action to take for next iteration of current loop in which this component is present</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTestLogicalAction()"> |
| <h3>getTestLogicalAction</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JMeterContext.TestLogicalAction.html" title="enum in org.apache.jmeter.threads">JMeterContext.TestLogicalAction</a></span> <span class="element-name">getTestLogicalAction</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>TestLogicalAction to start next iteration of current loop in which this component is present</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setStartNextThreadLoop(boolean)"> |
| <h3>setStartNextThreadLoop</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setStartNextThreadLoop</span><wbr><span class="parameters">(boolean restartNextLoop)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">use <a href="#setTestLogicalAction(org.apache.jmeter.threads.JMeterContext.TestLogicalAction)"><code>setTestLogicalAction(TestLogicalAction)</code></a></div> |
| </div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>restartNextLoop</code> - if set to <code>true</code> a restart of the loop will occur</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isStartNextThreadLoop()"> |
| <h3>isStartNextThreadLoop</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isStartNextThreadLoop</span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">use <a href="#getTestLogicalAction()"><code>getTestLogicalAction()</code></a></div> |
| </div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd><code>true</code> when current loop iteration of Thread Group will be interrupted and JMeter will go to next iteration of the Thread Group loop</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setRestartNextLoop(boolean)"> |
| <h3>setRestartNextLoop</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setRestartNextLoop</span><wbr><span class="parameters">(boolean restartNextLoop)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">use <a href="#setStartNextThreadLoop(boolean)"><code>setStartNextThreadLoop(boolean)</code></a></div> |
| </div> |
| <div class="block">if set to <code>true</code> current loop iteration will be interrupted and |
| JMeter will go to next iteration</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>restartNextLoop</code> - flag whether to restart</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isRestartNextLoop()"> |
| <h3>isRestartNextLoop</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isRestartNextLoop</span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">use <a href="#isStartNextThreadLoop()"><code>isStartNextThreadLoop()</code></a></div> |
| </div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>flag whether restart is set</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cleanAfterSample()"> |
| <h3>cleanAfterSample</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">cleanAfterSample</span>()</div> |
| <div class="block">Clean cached data after sample |
| Internally called by JMeter, never call it directly</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSamplerContext()"> |
| <h3>getSamplerContext</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></span> <span class="element-name">getSamplerContext</span>()</div> |
| <div class="block">Sampler context is cleaned up as soon as Post-Processor have ended</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Context to use within PostProcessors to cache data</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setRecording(boolean)"> |
| <h3>setRecording</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setRecording</span><wbr><span class="parameters">(boolean recording)</span></div> |
| <div class="block">Internally called by JMeter, never call it directly</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>recording</code> - flag whether recording should be done</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isRecording()"> |
| <h3>isRecording</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isRecording</span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 1998-2022 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
