| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>TestElement (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.testelement, interface: TestElement"> |
| <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.5.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><a href="#field-summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </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.testelement</a></div> |
| <h1 title="Interface TestElement" class="title">Interface TestElement</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html" title="class or interface in java.lang" class="external-link">Cloneable</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="../control/Controller.html" title="interface in org.apache.jmeter.control">Controller</a></code>, <code><a href="../samplers/Sampler.html" title="interface in org.apache.jmeter.samplers">Sampler</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../protocol/bolt/sampler/AbstractBoltTestElement.html" title="class in org.apache.jmeter.protocol.bolt.sampler">AbstractBoltTestElement</a></code>, <code><a href="../protocol/jdbc/processor/AbstractJDBCProcessor.html" title="class in org.apache.jmeter.protocol.jdbc.processor">AbstractJDBCProcessor</a></code>, <code><a href="../protocol/jdbc/AbstractJDBCTestElement.html" title="class in org.apache.jmeter.protocol.jdbc">AbstractJDBCTestElement</a></code>, <code><a href="../reporters/AbstractListenerElement.html" title="class in org.apache.jmeter.reporters">AbstractListenerElement</a></code>, <code><a href="../samplers/AbstractSampler.html" title="class in org.apache.jmeter.samplers">AbstractSampler</a></code>, <code><a href="AbstractScopedAssertion.html" title="class in org.apache.jmeter.testelement">AbstractScopedAssertion</a></code>, <code><a href="AbstractScopedTestElement.html" title="class in org.apache.jmeter.testelement">AbstractScopedTestElement</a></code>, <code><a href="AbstractTestElement.html" title="class in org.apache.jmeter.testelement">AbstractTestElement</a></code>, <code><a href="../threads/AbstractThreadGroup.html" title="class in org.apache.jmeter.threads">AbstractThreadGroup</a></code>, <code><a href="../protocol/http/sampler/AccessLogSampler.html" title="class in org.apache.jmeter.protocol.http.sampler">AccessLogSampler</a></code>, <code><a href="../protocol/http/sampler/AjpSampler.html" title="class in org.apache.jmeter.protocol.http.sampler">AjpSampler</a></code>, <code><a href="../protocol/http/modifier/AnchorModifier.html" title="class in org.apache.jmeter.protocol.http.modifier">AnchorModifier</a></code>, <code><a href="../config/Argument.html" title="class in org.apache.jmeter.config">Argument</a></code>, <code><a href="../config/Arguments.html" title="class in org.apache.jmeter.config">Arguments</a></code>, <code><a href="../protocol/http/control/AuthManager.html" title="class in org.apache.jmeter.protocol.http.control">AuthManager</a></code>, <code><a href="../protocol/http/control/Authorization.html" title="class in org.apache.jmeter.protocol.http.control">Authorization</a></code>, <code><a href="../visualizers/backend/BackendListener.html" title="class in org.apache.jmeter.visualizers.backend">BackendListener</a></code>, <code><a href="../protocol/jms/sampler/BaseJMSSampler.html" title="class in org.apache.jmeter.protocol.jms.sampler">BaseJMSSampler</a></code>, <code><a href="../assertions/BeanShellAssertion.html" title="class in org.apache.jmeter.assertions">BeanShellAssertion</a></code>, <code><a href="../visualizers/BeanShellListener.html" title="class in org.apache.jmeter.visualizers">BeanShellListener</a></code>, <code><a href="../extractor/BeanShellPostProcessor.html" title="class in org.apache.jmeter.extractor">BeanShellPostProcessor</a></code>, <code><a href="../modifiers/BeanShellPreProcessor.html" title="class in org.apache.jmeter.modifiers">BeanShellPreProcessor</a></code>, <code><a href="../protocol/java/sampler/BeanShellSampler.html" title="class in org.apache.jmeter.protocol.java.sampler">BeanShellSampler</a></code>, <code><a href="../util/BeanShellTestElement.html" title="class in org.apache.jmeter.util">BeanShellTestElement</a></code>, <code><a href="../timers/BeanShellTimer.html" title="class in org.apache.jmeter.timers">BeanShellTimer</a></code>, <code><a href="../protocol/bolt/config/BoltConnectionElement.html" title="class in org.apache.jmeter.protocol.bolt.config">BoltConnectionElement</a></code>, <code><a href="../protocol/bolt/sampler/BoltSampler.html" title="class in org.apache.jmeter.protocol.bolt.sampler">BoltSampler</a></code>, <code><a href="../extractor/BoundaryExtractor.html" title="class in org.apache.jmeter.extractor">BoundaryExtractor</a></code>, <code><a href="../assertions/BSFAssertion.html" title="class in org.apache.jmeter.assertions">BSFAssertion</a></code>, <code><a href="../visualizers/BSFListener.html" title="class in org.apache.jmeter.visualizers">BSFListener</a></code>, <code><a href="../extractor/BSFPostProcessor.html" title="class in org.apache.jmeter.extractor">BSFPostProcessor</a></code>, <code><a href="../modifiers/BSFPreProcessor.html" title="class in org.apache.jmeter.modifiers">BSFPreProcessor</a></code>, <code><a href="../protocol/java/sampler/BSFSampler.html" title="class in org.apache.jmeter.protocol.java.sampler">BSFSampler</a></code>, <code><a href="../util/BSFTestElement.html" title="class in org.apache.jmeter.util">BSFTestElement</a></code>, <code><a href="../timers/BSFTimer.html" title="class in org.apache.jmeter.timers">BSFTimer</a></code>, <code><a href="../protocol/http/control/CacheManager.html" title="class in org.apache.jmeter.protocol.http.control">CacheManager</a></code>, <code><a href="../assertions/CompareAssertion.html" title="class in org.apache.jmeter.assertions">CompareAssertion</a></code>, <code><a href="../config/ConfigTestElement.html" title="class in org.apache.jmeter.config">ConfigTestElement</a></code>, <code><a href="../timers/ConstantThroughputTimer.html" title="class in org.apache.jmeter.timers">ConstantThroughputTimer</a></code>, <code><a href="../timers/ConstantTimer.html" title="class in org.apache.jmeter.timers">ConstantTimer</a></code>, <code><a href="../protocol/http/control/Cookie.html" title="class in org.apache.jmeter.protocol.http.control">Cookie</a></code>, <code><a href="../protocol/http/control/CookieManager.html" title="class in org.apache.jmeter.protocol.http.control">CookieManager</a></code>, <code><a href="../modifiers/CounterConfig.html" title="class in org.apache.jmeter.modifiers">CounterConfig</a></code>, <code><a href="../control/CriticalSectionController.html" title="class in org.apache.jmeter.control">CriticalSectionController</a></code>, <code><a href="../config/CSVDataSet.html" title="class in org.apache.jmeter.config">CSVDataSet</a></code>, <code><a href="../protocol/jdbc/config/DataSourceElement.html" title="class in org.apache.jmeter.protocol.jdbc.config">DataSourceElement</a></code>, <code><a href="../extractor/DebugPostProcessor.html" title="class in org.apache.jmeter.extractor">DebugPostProcessor</a></code>, <code><a href="../sampler/DebugSampler.html" title="class in org.apache.jmeter.sampler">DebugSampler</a></code>, <code><a href="../protocol/http/control/DNSCacheManager.html" title="class in org.apache.jmeter.protocol.http.control">DNSCacheManager</a></code>, <code><a href="../assertions/DurationAssertion.html" title="class in org.apache.jmeter.assertions">DurationAssertion</a></code>, <code><a href="../control/ForeachController.html" title="class in org.apache.jmeter.control">ForeachController</a></code>, <code><a href="../protocol/ftp/sampler/FTPSampler.html" title="class in org.apache.jmeter.protocol.ftp.sampler">FTPSampler</a></code>, <code><a href="../timers/GaussianRandomTimer.html" title="class in org.apache.jmeter.timers">GaussianRandomTimer</a></code>, <code><a href="../control/GenericController.html" title="class in org.apache.jmeter.control">GenericController</a></code>, <code><a href="../protocol/http/control/Header.html" title="class in org.apache.jmeter.protocol.http.control">Header</a></code>, <code><a href="../protocol/http/control/HeaderManager.html" title="class in org.apache.jmeter.protocol.http.control">HeaderManager</a></code>, <code><a href="../assertions/HTMLAssertion.html" title="class in org.apache.jmeter.assertions">HTMLAssertion</a></code>, <code><a href="../extractor/HtmlExtractor.html" title="class in org.apache.jmeter.extractor">HtmlExtractor</a></code>, <code><a href="../protocol/http/util/HTTPArgument.html" title="class in org.apache.jmeter.protocol.http.util">HTTPArgument</a></code>, <code><a href="../protocol/http/util/HTTPFileArg.html" title="class in org.apache.jmeter.protocol.http.util">HTTPFileArg</a></code>, <code><a href="../protocol/http/util/HTTPFileArgs.html" title="class in org.apache.jmeter.protocol.http.util">HTTPFileArgs</a></code>, <code><a href="../protocol/http/control/HttpMirrorControl.html" title="class in org.apache.jmeter.protocol.http.control">HttpMirrorControl</a></code>, <code><a href="../protocol/http/sampler/HTTPSampler.html" title="class in org.apache.jmeter.protocol.http.sampler">HTTPSampler</a></code>, <code><a href="../protocol/http/sampler/HTTPSamplerBase.html" title="class in org.apache.jmeter.protocol.http.sampler">HTTPSamplerBase</a></code>, <code><a href="../protocol/http/sampler/HTTPSamplerProxy.html" title="class in org.apache.jmeter.protocol.http.sampler">HTTPSamplerProxy</a></code>, <code><a href="../control/IfController.html" title="class in org.apache.jmeter.control">IfController</a></code>, <code><a href="../control/IncludeController.html" title="class in org.apache.jmeter.control">IncludeController</a></code>, <code><a href="../control/InterleaveControl.html" title="class in org.apache.jmeter.control">InterleaveControl</a></code>, <code><a href="../protocol/java/config/JavaConfig.html" title="class in org.apache.jmeter.protocol.java.config">JavaConfig</a></code>, <code><a href="../protocol/java/sampler/JavaSampler.html" title="class in org.apache.jmeter.protocol.java.sampler">JavaSampler</a></code>, <code><a href="../protocol/jdbc/processor/JDBCPostProcessor.html" title="class in org.apache.jmeter.protocol.jdbc.processor">JDBCPostProcessor</a></code>, <code><a href="../protocol/jdbc/processor/JDBCPreProcessor.html" title="class in org.apache.jmeter.protocol.jdbc.processor">JDBCPreProcessor</a></code>, <code><a href="../protocol/jdbc/sampler/JDBCSampler.html" title="class in org.apache.jmeter.protocol.jdbc.sampler">JDBCSampler</a></code>, <code><a href="../assertions/jmespath/JMESPathAssertion.html" title="class in org.apache.jmeter.assertions.jmespath">JMESPathAssertion</a></code>, <code><a href="../extractor/json/jmespath/JMESPathExtractor.html" title="class in org.apache.jmeter.extractor.json.jmespath">JMESPathExtractor</a></code>, <code><a href="../protocol/jms/sampler/JMSProperties.html" title="class in org.apache.jmeter.protocol.jms.sampler">JMSProperties</a></code>, <code><a href="../protocol/jms/sampler/JMSProperty.html" title="class in org.apache.jmeter.protocol.jms.sampler">JMSProperty</a></code>, <code><a href="../protocol/jms/sampler/JMSSampler.html" title="class in org.apache.jmeter.protocol.jms.sampler">JMSSampler</a></code>, <code><a href="../assertions/JSONPathAssertion.html" title="class in org.apache.jmeter.assertions">JSONPathAssertion</a></code>, <code><a href="../extractor/json/jsonpath/JSONPostProcessor.html" title="class in org.apache.jmeter.extractor.json.jsonpath">JSONPostProcessor</a></code>, <code><a href="../assertions/JSR223Assertion.html" title="class in org.apache.jmeter.assertions">JSR223Assertion</a></code>, <code><a href="../visualizers/JSR223Listener.html" title="class in org.apache.jmeter.visualizers">JSR223Listener</a></code>, <code><a href="../extractor/JSR223PostProcessor.html" title="class in org.apache.jmeter.extractor">JSR223PostProcessor</a></code>, <code><a href="../modifiers/JSR223PreProcessor.html" title="class in org.apache.jmeter.modifiers">JSR223PreProcessor</a></code>, <code><a href="../protocol/java/sampler/JSR223Sampler.html" title="class in org.apache.jmeter.protocol.java.sampler">JSR223Sampler</a></code>, <code><a href="../util/JSR223TestElement.html" title="class in org.apache.jmeter.util">JSR223TestElement</a></code>, <code><a href="../timers/JSR223Timer.html" title="class in org.apache.jmeter.timers">JSR223Timer</a></code>, <code><a href="../protocol/java/sampler/JUnitSampler.html" title="class in org.apache.jmeter.protocol.java.sampler">JUnitSampler</a></code>, <code><a href="../config/KeystoreConfig.html" title="class in org.apache.jmeter.config">KeystoreConfig</a></code>, <code><a href="../protocol/ldap/config/gui/LDAPArgument.html" title="class in org.apache.jmeter.protocol.ldap.config.gui">LDAPArgument</a></code>, <code><a href="../protocol/ldap/config/gui/LDAPArguments.html" title="class in org.apache.jmeter.protocol.ldap.config.gui">LDAPArguments</a></code>, <code><a href="../protocol/ldap/sampler/LDAPExtSampler.html" title="class in org.apache.jmeter.protocol.ldap.sampler">LDAPExtSampler</a></code>, <code><a href="../protocol/ldap/sampler/LDAPSampler.html" title="class in org.apache.jmeter.protocol.ldap.sampler">LDAPSampler</a></code>, <code><a href="../config/LoginConfig.html" title="class in org.apache.jmeter.config">LoginConfig</a></code>, <code><a href="../control/LoopController.html" title="class in org.apache.jmeter.control">LoopController</a></code>, <code><a href="../reporters/MailerModel.html" title="class in org.apache.jmeter.reporters">MailerModel</a></code>, <code><a href="../reporters/MailerResultCollector.html" title="class in org.apache.jmeter.reporters">MailerResultCollector</a></code>, <code><a href="../protocol/mail/sampler/MailReaderSampler.html" title="class in org.apache.jmeter.protocol.mail.sampler">MailReaderSampler</a></code>, <code><a href="../assertions/MD5HexAssertion.html" title="class in org.apache.jmeter.assertions">MD5HexAssertion</a></code>, <code><a href="../control/ModuleController.html" title="class in org.apache.jmeter.control">ModuleController</a></code>, <code><a href="../protocol/mongodb/sampler/MongoScriptSampler.html" title="class in org.apache.jmeter.protocol.mongodb.sampler">MongoScriptSampler</a></code>, <code><a href="../protocol/mongodb/config/MongoSourceElement.html" title="class in org.apache.jmeter.protocol.mongodb.config">MongoSourceElement</a></code>, <code><a href="../control/OnceOnlyController.html" title="class in org.apache.jmeter.control">OnceOnlyController</a></code>, <code><a href="OnErrorTestElement.html" title="class in org.apache.jmeter.testelement">OnErrorTestElement</a></code>, <code><a href="../timers/PoissonRandomTimer.html" title="class in org.apache.jmeter.timers">PoissonRandomTimer</a></code>, <code><a href="../threads/PostThreadGroup.html" title="class in org.apache.jmeter.threads">PostThreadGroup</a></code>, <code><a href="../timers/poissonarrivals/PreciseThroughputTimer.html" title="class in org.apache.jmeter.timers.poissonarrivals">PreciseThroughputTimer</a></code>, <code><a href="../protocol/http/proxy/ProxyControl.html" title="class in org.apache.jmeter.protocol.http.proxy">ProxyControl</a></code>, <code><a href="../protocol/jms/sampler/PublisherSampler.html" title="class in org.apache.jmeter.protocol.jms.sampler">PublisherSampler</a></code>, <code><a href="../control/RandomController.html" title="class in org.apache.jmeter.control">RandomController</a></code>, <code><a href="../control/RandomOrderController.html" title="class in org.apache.jmeter.control">RandomOrderController</a></code>, <code><a href="../timers/RandomTimer.html" title="class in org.apache.jmeter.timers">RandomTimer</a></code>, <code><a href="../config/RandomVariableConfig.html" title="class in org.apache.jmeter.config">RandomVariableConfig</a></code>, <code><a href="../protocol/http/control/RecordingController.html" title="class in org.apache.jmeter.protocol.http.control">RecordingController</a></code>, <code><a href="../extractor/RegexExtractor.html" title="class in org.apache.jmeter.extractor">RegexExtractor</a></code>, <code><a href="../protocol/http/modifier/RegExUserParameters.html" title="class in org.apache.jmeter.protocol.http.modifier">RegExUserParameters</a></code>, <code><a href="../samplers/RemoteListenerWrapper.html" title="class in org.apache.jmeter.samplers">RemoteListenerWrapper</a></code>, <code><a href="../samplers/RemoteSampleListenerWrapper.html" title="class in org.apache.jmeter.samplers">RemoteSampleListenerWrapper</a></code>, <code><a href="../samplers/RemoteTestListenerWrapper.html" title="class in org.apache.jmeter.samplers">RemoteTestListenerWrapper</a></code>, <code><a href="../threads/RemoteThreadsListenerWrapper.html" title="class in org.apache.jmeter.threads">RemoteThreadsListenerWrapper</a></code>, <code><a href="../assertions/ResponseAssertion.html" title="class in org.apache.jmeter.assertions">ResponseAssertion</a></code>, <code><a href="../reporters/ResultAction.html" title="class in org.apache.jmeter.reporters">ResultAction</a></code>, <code><a href="../reporters/ResultCollector.html" title="class in org.apache.jmeter.reporters">ResultCollector</a></code>, <code><a href="../reporters/ResultSaver.html" title="class in org.apache.jmeter.reporters">ResultSaver</a></code>, <code><a href="../control/RunTime.html" title="class in org.apache.jmeter.control">RunTime</a></code>, <code><a href="../modifiers/SampleTimeout.html" title="class in org.apache.jmeter.modifiers">SampleTimeout</a></code>, <code><a href="../util/ScriptingTestElement.html" title="class in org.apache.jmeter.util">ScriptingTestElement</a></code>, <code><a href="../threads/SetupThreadGroup.html" title="class in org.apache.jmeter.threads">SetupThreadGroup</a></code>, <code><a href="../assertions/SizeAssertion.html" title="class in org.apache.jmeter.assertions">SizeAssertion</a></code>, <code><a href="../assertions/SMIMEAssertionTestElement.html" title="class in org.apache.jmeter.assertions">SMIMEAssertionTestElement</a></code>, <code><a href="../protocol/smtp/sampler/SmtpSampler.html" title="class in org.apache.jmeter.protocol.smtp.sampler">SmtpSampler</a></code>, <code><a href="../protocol/http/control/StaticHost.html" title="class in org.apache.jmeter.protocol.http.control">StaticHost</a></code>, <code><a href="../protocol/jms/sampler/SubscriberSampler.html" title="class in org.apache.jmeter.protocol.jms.sampler">SubscriberSampler</a></code>, <code><a href="../assertions/SubstitutionElement.html" title="class in org.apache.jmeter.assertions">SubstitutionElement</a></code>, <code><a href="../reporters/Summariser.html" title="class in org.apache.jmeter.reporters">Summariser</a></code>, <code><a href="../control/SwitchController.html" title="class in org.apache.jmeter.control">SwitchController</a></code>, <code><a href="../timers/SyncTimer.html" title="class in org.apache.jmeter.timers">SyncTimer</a></code>, <code><a href="../protocol/system/SystemSampler.html" title="class in org.apache.jmeter.protocol.system">SystemSampler</a></code>, <code><a href="../protocol/tcp/sampler/TCPSampler.html" title="class in org.apache.jmeter.protocol.tcp.sampler">TCPSampler</a></code>, <code><a href="../sampler/TestAction.html" title="class in org.apache.jmeter.sampler">TestAction</a></code>, <code><a href="../control/TestFragmentController.html" title="class in org.apache.jmeter.control">TestFragmentController</a></code>, <code><a href="TestPlan.html" title="class in org.apache.jmeter.testelement">TestPlan</a></code>, <code><a href="../threads/ThreadGroup.html" title="class in org.apache.jmeter.threads">ThreadGroup</a></code>, <code><a href="../control/ThroughputController.html" title="class in org.apache.jmeter.control">ThroughputController</a></code>, <code><a href="../control/TransactionController.html" title="class in org.apache.jmeter.control">TransactionController</a></code>, <code><a href="../control/TransactionSampler.html" title="class in org.apache.jmeter.control">TransactionSampler</a></code>, <code><a href="../timers/UniformRandomTimer.html" title="class in org.apache.jmeter.timers">UniformRandomTimer</a></code>, <code><a href="../protocol/http/modifier/URLRewritingModifier.html" title="class in org.apache.jmeter.protocol.http.modifier">URLRewritingModifier</a></code>, <code><a href="../modifiers/UserParameters.html" title="class in org.apache.jmeter.modifiers">UserParameters</a></code>, <code><a href="../control/WhileController.html" title="class in org.apache.jmeter.control">WhileController</a></code>, <code><a href="WorkBench.html" title="class in org.apache.jmeter.testelement">WorkBench</a></code>, <code><a href="../assertions/XMLAssertion.html" title="class in org.apache.jmeter.assertions">XMLAssertion</a></code>, <code><a href="../assertions/XMLSchemaAssertion.html" title="class in org.apache.jmeter.assertions">XMLSchemaAssertion</a></code>, <code><a href="../assertions/XPath2Assertion.html" title="class in org.apache.jmeter.assertions">XPath2Assertion</a></code>, <code><a href="../extractor/XPath2Extractor.html" title="class in org.apache.jmeter.extractor">XPath2Extractor</a></code>, <code><a href="../assertions/XPathAssertion.html" title="class in org.apache.jmeter.assertions">XPathAssertion</a></code>, <code><a href="../extractor/XPathExtractor.html" title="class in org.apache.jmeter.extractor">XPathExtractor</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">TestElement</span><span class="extends-implements"> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html" title="class or interface in java.lang" class="external-link">Cloneable</a></span></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</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">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final <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></code></div> |
| <div class="col-second even-row-color"><code><a href="#COMMENTS" class="member-name-link">COMMENTS</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <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></code></div> |
| <div class="col-second odd-row-color"><code><a href="#ENABLED" class="member-name-link">ENABLED</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final <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></code></div> |
| <div class="col-second even-row-color"><code><a href="#GUI_CLASS" class="member-name-link">GUI_CLASS</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <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></code></div> |
| <div class="col-second odd-row-color"><code><a href="#NAME" class="member-name-link">NAME</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final <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></code></div> |
| <div class="col-second even-row-color"><code><a href="#TEST_CLASS" class="member-name-link">TEST_CLASS</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-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><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default 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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#addTestElement(org.apache.jmeter.testelement.TestElement)" class="member-name-link">addTestElement</a><wbr>(<a href="TestElement.html" title="interface in org.apache.jmeter.testelement">TestElement</a> child)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#canRemove()" class="member-name-link">canRemove</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Called by Remove to determine if it is safe to remove the element.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#clear()" class="member-name-link">clear</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Clear the TestElement of all data.</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="#clearTestElementChildren()" class="member-name-link">clearTestElementChildren</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">This method should clear any test element properties that are merged |
| by <a href="#addTestElement(org.apache.jmeter.testelement.TestElement)"><code>addTestElement(TestElement)</code></a>.</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/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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#clone()" class="member-name-link">clone</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </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/javase/8/docs/api/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="#getComment()" class="member-name-link">getComment</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns comment associated with this element.</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/javase/8/docs/api/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="#getName()" class="member-name-link">getName</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get the name of this test element</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="property/JMeterProperty.html" title="interface in org.apache.jmeter.testelement.property">JMeterProperty</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getProperty(java.lang.String)" class="member-name-link">getProperty</a><wbr>(<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> propName)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Given the name of the property, returns the appropriate property from |
| JMeter.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPropertyAsBoolean(java.lang.String)" class="member-name-link">getPropertyAsBoolean</a><wbr>(<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> key)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Return a property as a boolean value.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPropertyAsBoolean(java.lang.String,boolean)" class="member-name-link">getPropertyAsBoolean</a><wbr>(<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> key, |
| boolean defaultValue)</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 property as a boolean value or a default value if no property |
| could be found.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPropertyAsDouble(java.lang.String)" class="member-name-link">getPropertyAsDouble</a><wbr>(<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> key)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Return a property as a double value.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>float</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPropertyAsFloat(java.lang.String)" class="member-name-link">getPropertyAsFloat</a><wbr>(<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> key)</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 property as a float value.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPropertyAsInt(java.lang.String)" class="member-name-link">getPropertyAsInt</a><wbr>(<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> key)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Return a property as an int value.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPropertyAsInt(java.lang.String,int)" class="member-name-link">getPropertyAsInt</a><wbr>(<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> key, |
| int defaultValue)</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 property as an int value or a default value if no property |
| could be found.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPropertyAsLong(java.lang.String)" class="member-name-link">getPropertyAsLong</a><wbr>(<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> key)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Return a property as a long value.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPropertyAsLong(java.lang.String,long)" class="member-name-link">getPropertyAsLong</a><wbr>(<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> key, |
| long defaultValue)</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 property as a long value or a default value if no property |
| could be found.</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/javase/8/docs/api/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="#getPropertyAsString(java.lang.String)" class="member-name-link">getPropertyAsString</a><wbr>(<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> key)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Return a property as a string value.</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/javase/8/docs/api/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="#getPropertyAsString(java.lang.String,java.lang.String)" class="member-name-link">getPropertyAsString</a><wbr>(<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> key, |
| <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> defaultValue)</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 property as an string value or a default value if no property |
| could be found.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../threads/JMeterContext.html" title="class in org.apache.jmeter.threads">JMeterContext</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getThreadContext()" class="member-name-link">getThreadContext</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </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/javase/8/docs/api/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="#getThreadName()" class="member-name-link">getThreadName</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the threadName.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isEnabled()" class="member-name-link">isEnabled</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Check if ENABLED property is present and true ; defaults to true</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isRunningVersion()" class="member-name-link">isRunningVersion</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns true or false whether the element is the running version.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isTemporary(org.apache.jmeter.testelement.property.JMeterProperty)" class="member-name-link">isTemporary</a><wbr>(<a href="property/JMeterProperty.html" title="interface in org.apache.jmeter.testelement.property">JMeterProperty</a> property)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Test whether a given property is only a temporary resident of the |
| TestElement</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="property/PropertyIterator.html" title="interface in org.apache.jmeter.testelement.property">PropertyIterator</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#propertyIterator()" class="member-name-link">propertyIterator</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Get a Property Iterator for the TestElements properties.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#recoverRunningVersion()" class="member-name-link">recoverRunningVersion</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Tells the test element to return to the state it was in when |
| setRunningVersion(true) was called.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#removed()" class="member-name-link">removed</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Called when the test element is removed from the test plan.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#removeProperty(java.lang.String)" class="member-name-link">removeProperty</a><wbr>(<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> key)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Remove property stored under the <code>key</code></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="#setComment(java.lang.String)" class="member-name-link">setComment</a><wbr>(<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> comment)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Associates a comment with this element</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setEnabled(boolean)" class="member-name-link">setEnabled</a><wbr>(boolean enabled)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Set the enabled status of the test element</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="#setName(java.lang.String)" class="member-name-link">setName</a><wbr>(<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> name)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Associates a name with this element.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setProperty(java.lang.String,boolean)" class="member-name-link">setProperty</a><wbr>(<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> key, |
| boolean value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </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="#setProperty(java.lang.String,boolean,boolean)" class="member-name-link">setProperty</a><wbr>(<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> key, |
| boolean value, |
| boolean dflt)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setProperty(java.lang.String,int)" class="member-name-link">setProperty</a><wbr>(<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> key, |
| int value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </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="#setProperty(java.lang.String,int,int)" class="member-name-link">setProperty</a><wbr>(<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> key, |
| int value, |
| int dflt)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setProperty(java.lang.String,long)" class="member-name-link">setProperty</a><wbr>(<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> name, |
| long value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </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="#setProperty(java.lang.String,long,long)" class="member-name-link">setProperty</a><wbr>(<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> name, |
| long value, |
| long dflt)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setProperty(java.lang.String,java.lang.String)" class="member-name-link">setProperty</a><wbr>(<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> key, |
| <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> value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </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="#setProperty(java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">setProperty</a><wbr>(<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> key, |
| <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> value, |
| <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> dflt)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setProperty(org.apache.jmeter.testelement.property.JMeterProperty)" class="member-name-link">setProperty</a><wbr>(<a href="property/JMeterProperty.html" title="interface in org.apache.jmeter.testelement.property">JMeterProperty</a> property)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets and overwrites a property in the TestElement.</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="#setRunningVersion(boolean)" class="member-name-link">setRunningVersion</a><wbr>(boolean run)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Make the test element the running version, or make it no longer the |
| running version.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setTemporary(org.apache.jmeter.testelement.property.JMeterProperty)" class="member-name-link">setTemporary</a><wbr>(<a href="property/JMeterProperty.html" title="interface in org.apache.jmeter.testelement.property">JMeterProperty</a> property)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Indicate that the given property should be only a temporary property in |
| the TestElement</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="#setThreadContext(org.apache.jmeter.threads.JMeterContext)" class="member-name-link">setThreadContext</a><wbr>(<a href="../threads/JMeterContext.html" title="class in org.apache.jmeter.threads">JMeterContext</a> threadContext)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setThreadName(java.lang.String)" class="member-name-link">setThreadName</a><wbr>(<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> threadName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Configures thread name.</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="#traverse(org.apache.jmeter.testelement.TestElementTraverser)" class="member-name-link">traverse</a><wbr>(<a href="TestElementTraverser.html" title="interface in org.apache.jmeter.testelement">TestElementTraverser</a> traverser)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Convenient way to traverse a test element.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="NAME"> |
| <h3>NAME</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><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></span> <span class="element-name">NAME</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../constant-values.html#org.apache.jmeter.testelement.TestElement.NAME">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="GUI_CLASS"> |
| <h3>GUI_CLASS</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><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></span> <span class="element-name">GUI_CLASS</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../constant-values.html#org.apache.jmeter.testelement.TestElement.GUI_CLASS">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ENABLED"> |
| <h3>ENABLED</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><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></span> <span class="element-name">ENABLED</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../constant-values.html#org.apache.jmeter.testelement.TestElement.ENABLED">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="TEST_CLASS"> |
| <h3>TEST_CLASS</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><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></span> <span class="element-name">TEST_CLASS</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../constant-values.html#org.apache.jmeter.testelement.TestElement.TEST_CLASS">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="COMMENTS"> |
| <h3>COMMENTS</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><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></span> <span class="element-name">COMMENTS</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../constant-values.html#org.apache.jmeter.testelement.TestElement.COMMENTS">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="addTestElement(org.apache.jmeter.testelement.TestElement)"> |
| <h3>addTestElement</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">addTestElement</span><wbr><span class="parameters">(<a href="TestElement.html" title="interface in org.apache.jmeter.testelement">TestElement</a> child)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="clearTestElementChildren()"> |
| <h3>clearTestElementChildren</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">clearTestElementChildren</span>()</div> |
| <div class="block">This method should clear any test element properties that are merged |
| by <a href="#addTestElement(org.apache.jmeter.testelement.TestElement)"><code>addTestElement(TestElement)</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setProperty(java.lang.String,java.lang.String)"> |
| <h3>setProperty</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">setProperty</span><wbr><span class="parameters">(<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> key, |
| <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> value)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setProperty(java.lang.String,java.lang.String,java.lang.String)"> |
| <h3>setProperty</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">setProperty</span><wbr><span class="parameters">(<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> key, |
| <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> value, |
| <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> dflt)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setProperty(java.lang.String,boolean)"> |
| <h3>setProperty</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">setProperty</span><wbr><span class="parameters">(<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> key, |
| boolean value)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setProperty(java.lang.String,boolean,boolean)"> |
| <h3>setProperty</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">setProperty</span><wbr><span class="parameters">(<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> key, |
| boolean value, |
| boolean dflt)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setProperty(java.lang.String,int)"> |
| <h3>setProperty</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">setProperty</span><wbr><span class="parameters">(<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> key, |
| int value)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setProperty(java.lang.String,int,int)"> |
| <h3>setProperty</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">setProperty</span><wbr><span class="parameters">(<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> key, |
| int value, |
| int dflt)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setProperty(java.lang.String,long)"> |
| <h3>setProperty</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">setProperty</span><wbr><span class="parameters">(<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> name, |
| long value)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setProperty(java.lang.String,long,long)"> |
| <h3>setProperty</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">setProperty</span><wbr><span class="parameters">(<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> name, |
| long value, |
| long dflt)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isEnabled()"> |
| <h3>isEnabled</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isEnabled</span>()</div> |
| <div class="block">Check if ENABLED property is present and true ; defaults to true</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if element is enabled</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setEnabled(boolean)"> |
| <h3>setEnabled</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">setEnabled</span><wbr><span class="parameters">(boolean enabled)</span></div> |
| <div class="block">Set the enabled status of the test element</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>enabled</code> - the status to set</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isRunningVersion()"> |
| <h3>isRunningVersion</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isRunningVersion</span>()</div> |
| <div class="block">Returns true or false whether the element is the running version.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if the element is the running version</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isTemporary(org.apache.jmeter.testelement.property.JMeterProperty)"> |
| <h3>isTemporary</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isTemporary</span><wbr><span class="parameters">(<a href="property/JMeterProperty.html" title="interface in org.apache.jmeter.testelement.property">JMeterProperty</a> property)</span></div> |
| <div class="block">Test whether a given property is only a temporary resident of the |
| TestElement</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>property</code> - the property to be tested</dd> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if property is temporary</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setTemporary(org.apache.jmeter.testelement.property.JMeterProperty)"> |
| <h3>setTemporary</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">setTemporary</span><wbr><span class="parameters">(<a href="property/JMeterProperty.html" title="interface in org.apache.jmeter.testelement.property">JMeterProperty</a> property)</span></div> |
| <div class="block">Indicate that the given property should be only a temporary property in |
| the TestElement</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>property</code> - void</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPropertyAsBoolean(java.lang.String)"> |
| <h3>getPropertyAsBoolean</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">getPropertyAsBoolean</span><wbr><span class="parameters">(<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> key)</span></div> |
| <div class="block">Return a property as a boolean value.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - the name of the property to get</dd> |
| <dt>Returns:</dt> |
| <dd>the value of the property</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPropertyAsBoolean(java.lang.String,boolean)"> |
| <h3>getPropertyAsBoolean</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">getPropertyAsBoolean</span><wbr><span class="parameters">(<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> key, |
| boolean defaultValue)</span></div> |
| <div class="block">Return a property as a boolean value or a default value if no property |
| could be found.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - the name of the property to get</dd> |
| <dd><code>defaultValue</code> - the default value to use</dd> |
| <dt>Returns:</dt> |
| <dd>the value of the property, or <code>defaultValue</code> if no |
| property could be found</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPropertyAsLong(java.lang.String)"> |
| <h3>getPropertyAsLong</h3> |
| <div class="member-signature"><span class="return-type">long</span> <span class="element-name">getPropertyAsLong</span><wbr><span class="parameters">(<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> key)</span></div> |
| <div class="block">Return a property as a long value.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - the name of the property to get</dd> |
| <dt>Returns:</dt> |
| <dd>the value of the property</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPropertyAsLong(java.lang.String,long)"> |
| <h3>getPropertyAsLong</h3> |
| <div class="member-signature"><span class="return-type">long</span> <span class="element-name">getPropertyAsLong</span><wbr><span class="parameters">(<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> key, |
| long defaultValue)</span></div> |
| <div class="block">Return a property as a long value or a default value if no property |
| could be found.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - the name of the property to get</dd> |
| <dd><code>defaultValue</code> - the default value to use</dd> |
| <dt>Returns:</dt> |
| <dd>the value of the property, or <code>defaultValue</code> if no |
| property could be found</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPropertyAsInt(java.lang.String)"> |
| <h3>getPropertyAsInt</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name">getPropertyAsInt</span><wbr><span class="parameters">(<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> key)</span></div> |
| <div class="block">Return a property as an int value.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - the name of the property to get</dd> |
| <dt>Returns:</dt> |
| <dd>the value of the property</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPropertyAsInt(java.lang.String,int)"> |
| <h3>getPropertyAsInt</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name">getPropertyAsInt</span><wbr><span class="parameters">(<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> key, |
| int defaultValue)</span></div> |
| <div class="block">Return a property as an int value or a default value if no property |
| could be found.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - the name of the property to get</dd> |
| <dd><code>defaultValue</code> - the default value to use</dd> |
| <dt>Returns:</dt> |
| <dd>the value of the property, or <code>defaultValue</code> if no |
| property could be found</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPropertyAsFloat(java.lang.String)"> |
| <h3>getPropertyAsFloat</h3> |
| <div class="member-signature"><span class="return-type">float</span> <span class="element-name">getPropertyAsFloat</span><wbr><span class="parameters">(<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> key)</span></div> |
| <div class="block">Return a property as a float value.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - the name of the property to get</dd> |
| <dt>Returns:</dt> |
| <dd>the value of the property</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPropertyAsDouble(java.lang.String)"> |
| <h3>getPropertyAsDouble</h3> |
| <div class="member-signature"><span class="return-type">double</span> <span class="element-name">getPropertyAsDouble</span><wbr><span class="parameters">(<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> key)</span></div> |
| <div class="block">Return a property as a double value.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - the name of the property to get</dd> |
| <dt>Returns:</dt> |
| <dd>the value of the property</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setRunningVersion(boolean)"> |
| <h3>setRunningVersion</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">setRunningVersion</span><wbr><span class="parameters">(boolean run)</span></div> |
| <div class="block">Make the test element the running version, or make it no longer the |
| running version. This tells the test element that it's current state must |
| be retrievable by a call to recoverRunningVersion(). It is kind of like |
| making the TestElement Read- Only, but not as strict. Changes can be made |
| and the element can be modified, but the state of the element at the time |
| of the call to setRunningVersion() must be recoverable.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>run</code> - flag whether this element should be the running version</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="recoverRunningVersion()"> |
| <h3>recoverRunningVersion</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">recoverRunningVersion</span>()</div> |
| <div class="block">Tells the test element to return to the state it was in when |
| setRunningVersion(true) was called.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="clear()"> |
| <h3>clear</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">clear</span>()</div> |
| <div class="block">Clear the TestElement of all data.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPropertyAsString(java.lang.String)"> |
| <h3>getPropertyAsString</h3> |
| <div class="member-signature"><span class="return-type"><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></span> <span class="element-name">getPropertyAsString</span><wbr><span class="parameters">(<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> key)</span></div> |
| <div class="block">Return a property as a string value.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - the name of the property to get</dd> |
| <dt>Returns:</dt> |
| <dd>the value of the property</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPropertyAsString(java.lang.String,java.lang.String)"> |
| <h3>getPropertyAsString</h3> |
| <div class="member-signature"><span class="return-type"><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></span> <span class="element-name">getPropertyAsString</span><wbr><span class="parameters">(<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> key, |
| <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> defaultValue)</span></div> |
| <div class="block">Return a property as an string value or a default value if no property |
| could be found.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - the name of the property to get</dd> |
| <dd><code>defaultValue</code> - the default value to use</dd> |
| <dt>Returns:</dt> |
| <dd>the value of the property, or <code>defaultValue</code> if no |
| property could be found</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setProperty(org.apache.jmeter.testelement.property.JMeterProperty)"> |
| <h3>setProperty</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">setProperty</span><wbr><span class="parameters">(<a href="property/JMeterProperty.html" title="interface in org.apache.jmeter.testelement.property">JMeterProperty</a> property)</span></div> |
| <div class="block">Sets and overwrites a property in the TestElement. This call will be |
| ignored if the TestElement is currently a "running version".</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>property</code> - the property to be set</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getProperty(java.lang.String)"> |
| <h3>getProperty</h3> |
| <div class="member-signature"><span class="return-type"><a href="property/JMeterProperty.html" title="interface in org.apache.jmeter.testelement.property">JMeterProperty</a></span> <span class="element-name">getProperty</span><wbr><span class="parameters">(<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> propName)</span></div> |
| <div class="block">Given the name of the property, returns the appropriate property from |
| JMeter. If it is null, a NullProperty object will be returned.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>propName</code> - the name of the property to get</dd> |
| <dt>Returns:</dt> |
| <dd><a href="property/JMeterProperty.html" title="interface in org.apache.jmeter.testelement.property"><code>JMeterProperty</code></a> stored under the name, or |
| <a href="property/NullProperty.html" title="class in org.apache.jmeter.testelement.property"><code>NullProperty</code></a> if no property can be found</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="propertyIterator()"> |
| <h3>propertyIterator</h3> |
| <div class="member-signature"><span class="return-type"><a href="property/PropertyIterator.html" title="interface in org.apache.jmeter.testelement.property">PropertyIterator</a></span> <span class="element-name">propertyIterator</span>()</div> |
| <div class="block">Get a Property Iterator for the TestElements properties.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>PropertyIterator</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="removeProperty(java.lang.String)"> |
| <h3>removeProperty</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">removeProperty</span><wbr><span class="parameters">(<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> key)</span></div> |
| <div class="block">Remove property stored under the <code>key</code></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - name of the property to be removed</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="clone()"> |
| <h3>clone</h3> |
| <div class="member-signature"><span class="return-type"><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">clone</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="traverse(org.apache.jmeter.testelement.TestElementTraverser)"> |
| <h3>traverse</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">traverse</span><wbr><span class="parameters">(<a href="TestElementTraverser.html" title="interface in org.apache.jmeter.testelement">TestElementTraverser</a> traverser)</span></div> |
| <div class="block">Convenient way to traverse a test element.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>traverser</code> - The traverser that is notified of the contained elements</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getThreadContext()"> |
| <h3>getThreadContext</h3> |
| <div class="member-signature"><span class="return-type"><a href="../threads/JMeterContext.html" title="class in org.apache.jmeter.threads">JMeterContext</a></span> <span class="element-name">getThreadContext</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Returns the threadContext.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setThreadContext(org.apache.jmeter.threads.JMeterContext)"> |
| <h3>setThreadContext</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">setThreadContext</span><wbr><span class="parameters">(<a href="../threads/JMeterContext.html" title="class in org.apache.jmeter.threads">JMeterContext</a> threadContext)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>threadContext</code> - The threadContext to set.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getThreadName()"> |
| <h3>getThreadName</h3> |
| <div class="member-signature"><span class="return-type"><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></span> <span class="element-name">getThreadName</span>()</div> |
| <div class="block">Returns the threadName.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the threadName.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setThreadName(java.lang.String)"> |
| <h3>setThreadName</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">setThreadName</span><wbr><span class="parameters">(<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> threadName)</span></div> |
| <div class="block">Configures thread name.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>threadName</code> - the threadName to set.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="canRemove()"> |
| <h3>canRemove</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">canRemove</span>()</div> |
| <div class="block">Called by Remove to determine if it is safe to remove the element. The |
| element can either clean itself up, and return true, or the element can |
| return false.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if safe to remove the element</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getName()"> |
| <h3>getName</h3> |
| <div class="member-signature"><span class="return-type"><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></span> <span class="element-name">getName</span>()</div> |
| <div class="block">Get the name of this test element</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>name of this element</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setName(java.lang.String)"> |
| <h3>setName</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">setName</span><wbr><span class="parameters">(<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> name)</span></div> |
| <div class="block">Associates a name with this element.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - to be associated</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getComment()"> |
| <h3>getComment</h3> |
| <div class="member-signature"><span class="return-type"><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></span> <span class="element-name">getComment</span>()</div> |
| <div class="block">Returns comment associated with this element.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>comment associated with this element</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setComment(java.lang.String)"> |
| <h3>setComment</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">setComment</span><wbr><span class="parameters">(<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> comment)</span></div> |
| <div class="block">Associates a comment with this element</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>comment</code> - to be associated</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="removed()"> |
| <h3>removed</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">void</span> <span class="element-name">removed</span>()</div> |
| <div class="block">Called when the test element is removed from the test plan. |
| Must not throw any exception</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> |
