api/org/apache/jmeter/report/processor/AbstractSampleConsumer.html - jmeter-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
 <title>AbstractSampleConsumer (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.report.processor, class: AbstractSampleConsumer">
 <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:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method-summary">Method</a></li>
 </ul>
 <ul class="sub-nav-list">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.jmeter.report.processor</a></div>
 <h1 title="Class AbstractSampleConsumer" class="title">Class AbstractSampleConsumer</h1>
 </div>
 <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
 <div class="inheritance"><a href="AbstractSampleProcessor.html" title="class in org.apache.jmeter.report.processor">org.apache.jmeter.report.processor.AbstractSampleProcessor</a>
 <div class="inheritance">org.apache.jmeter.report.processor.AbstractSampleConsumer</div>
 </div>
 </div>
 <section class="class-description" id="class-description">
 <dl class="notes">
 <dt>All Implemented Interfaces:</dt>
 <dd><code><a href="SampleConsumer.html" title="interface in org.apache.jmeter.report.processor">SampleConsumer</a></code>, <code><a href="SampleProcessor.html" title="interface in org.apache.jmeter.report.processor">SampleProcessor</a></code>, <code><a href="SampleProducer.html" title="interface in org.apache.jmeter.report.processor">SampleProducer</a></code></dd>
 </dl>
 <dl class="notes">
 <dt>Direct Known Subclasses:</dt>
 <dd><code><a href="graph/AbstractGraphConsumer.html" title="class in org.apache.jmeter.report.processor.graph">AbstractGraphConsumer</a></code>, <code><a href="AbstractSummaryConsumer.html" title="class in org.apache.jmeter.report.processor">AbstractSummaryConsumer</a></code>, <code><a href="AggregateConsumer.html" title="class in org.apache.jmeter.report.processor">AggregateConsumer</a></code>, <code><a href="ExternalSampleSorter.html" title="class in org.apache.jmeter.report.processor">ExternalSampleSorter</a></code>, <code><a href="FilterConsumer.html" title="class in org.apache.jmeter.report.processor">FilterConsumer</a></code>, <code><a href="NormalizerSampleConsumer.html" title="class in org.apache.jmeter.report.processor">NormalizerSampleConsumer</a></code>, <code><a href="RequestsSummaryConsumer.html" title="class in org.apache.jmeter.report.processor">RequestsSummaryConsumer</a></code>, <code><a href="SampleWriterConsumer.html" title="class in org.apache.jmeter.report.processor">SampleWriterConsumer</a></code>, <code><a href="TaggerConsumer.html" title="class in org.apache.jmeter.report.processor">TaggerConsumer</a></code></dd>
 </dl>
 <hr>
 <div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">AbstractSampleConsumer</span>
 <span class="extends-implements">extends <a href="AbstractSampleProcessor.html" title="class in org.apache.jmeter.report.processor">AbstractSampleProcessor</a>
 implements <a href="SampleConsumer.html" title="interface in org.apache.jmeter.report.processor">SampleConsumer</a>, <a href="SampleProducer.html" title="interface in org.apache.jmeter.report.processor">SampleProducer</a></span></div>
 <div class="block">Base class for sample consumer implementations.<br>
  Every sample consumer should extends this class to support basic consumer
  features.</div>
 <dl class="notes">
 <dt>Since:</dt>
 <dd>3.0</dd>
 </dl>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 <li>
 <section class="constructor-summary" id="constructor-summary">
 <h2>Constructor Summary</h2>
 <div class="caption"><span>Constructors</span></div>
 <div class="summary-table two-column-summary">
 <div class="table-header col-first">Constructor</div>
 <div class="table-header col-last">Description</div>
 <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">AbstractSampleConsumer</a>()</code></div>
 <div class="col-last even-row-color">&nbsp;</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></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="#addSampleConsumer(org.apache.jmeter.report.processor.SampleConsumer)" class="member-name-link">addSampleConsumer</a><wbr>(<a href="SampleConsumer.html" title="interface in org.apache.jmeter.report.processor">SampleConsumer</a>&nbsp;consumer)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</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="#getConsumedChannelCount()" class="member-name-link">getConsumedChannelCount</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../core/SampleMetadata.html" title="class in org.apache.jmeter.report.core">SampleMetadata</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getConsumedMetadata(int)" class="member-name-link">getConsumedMetadata</a><wbr>(int&nbsp;channel)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="SampleConsumer.html" title="interface in org.apache.jmeter.report.processor">SampleConsumer</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getConsumer(int)" class="member-name-link">getConsumer</a><wbr>(int&nbsp;i)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/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-tab4"><code><a href="#getDataFromContext(java.lang.String)" class="member-name-link">getDataFromContext</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;key)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Gets the data identified by the specified key from the current sample
  context</div>
 </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/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getName()" class="member-name-link">getName</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Gets the name of the consumer.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getWorkingDirectory()" class="member-name-link">getWorkingDirectory</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</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="#produce(org.apache.jmeter.report.core.Sample,int)" class="member-name-link">produce</a><wbr>(<a href="../core/Sample.html" title="class in org.apache.jmeter.report.core">Sample</a>&nbsp;s,
  int&nbsp;channel)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Produce a single sample on the specified channel</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="#removeSampleConsumer(org.apache.jmeter.report.processor.SampleConsumer)" class="member-name-link">removeSampleConsumer</a><wbr>(<a href="SampleConsumer.html" title="interface in org.apache.jmeter.report.processor">SampleConsumer</a>&nbsp;consumer)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</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="#setChannelAttribute(int,java.lang.String,java.lang.Object)" class="member-name-link">setChannelAttribute</a><wbr>(int&nbsp;channel,
  <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;key,
  <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;value)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Associate an attribute to the specified channel for this sample processor<br>
  If the attribute already exist, it is replaced.</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="#setConsumedMetadata(org.apache.jmeter.report.core.SampleMetadata,int)" class="member-name-link">setConsumedMetadata</a><wbr>(<a href="../core/SampleMetadata.html" title="class in org.apache.jmeter.report.core">SampleMetadata</a>&nbsp;sampleMetadata,
  int&nbsp;channel)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Set the metadata of samples that will be consumed on the specified
  channel.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected final void</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setDataToContext(java.lang.String,java.lang.Object)" class="member-name-link">setDataToContext</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;key,
  <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;value)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Store data in the current sample context with the specified key
  identifier.</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="#setName(java.lang.String)" class="member-name-link">setName</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Sets the name of the consumer.</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="#setProducedMetadata(org.apache.jmeter.report.core.SampleMetadata,int)" class="member-name-link">setProducedMetadata</a><wbr>(<a href="../core/SampleMetadata.html" title="class in org.apache.jmeter.report.core">SampleMetadata</a>&nbsp;metadata,
  int&nbsp;channel)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Set the metadata associated with the specified channel</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="#setSampleConsumer(org.apache.jmeter.report.processor.SampleConsumer)" class="member-name-link">setSampleConsumer</a><wbr>(<a href="SampleConsumer.html" title="interface in org.apache.jmeter.report.processor">SampleConsumer</a>&nbsp;consumer)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</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="#setSampleConsumers(java.util.List)" class="member-name-link">setSampleConsumers</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="SampleConsumer.html" title="interface in org.apache.jmeter.report.processor">SampleConsumer</a>&gt;&nbsp;consumers)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Sets the consumers</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="#setSampleContext(org.apache.jmeter.report.processor.SampleContext)" class="member-name-link">setSampleContext</a><wbr>(<a href="SampleContext.html" title="class in org.apache.jmeter.report.processor">SampleContext</a>&nbsp;sampleContext)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Set sample context that this consumer should rely on.</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="#startProducing()" class="member-name-link">startProducing</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Start producing samples, must be invoked before any call to
  <code>produce()</code></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="#stopProducing()" class="member-name-link">stopProducing</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Stop producing samples, no <code>produce()</code> call should occur after
  this service has been called.</div>
 </div>
 </div>
 </div>
 </div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-org.apache.jmeter.report.processor.AbstractSampleProcessor">Methods inherited from class&nbsp;org.apache.jmeter.report.processor.<a href="AbstractSampleProcessor.html" title="class in org.apache.jmeter.report.processor">AbstractSampleProcessor</a></h3>
 <code><a href="AbstractSampleProcessor.html#getChannelAttribute(int,java.lang.String)">getChannelAttribute</a>, <a href="AbstractSampleProcessor.html#getSampleContext()">getSampleContext</a></code></div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
 <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/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/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-org.apache.jmeter.report.processor.SampleConsumer">Methods inherited from interface&nbsp;org.apache.jmeter.report.processor.<a href="SampleConsumer.html" title="interface in org.apache.jmeter.report.processor">SampleConsumer</a></h3>
 <code><a href="SampleConsumer.html#consume(org.apache.jmeter.report.core.Sample,int)">consume</a>, <a href="SampleConsumer.html#startConsuming()">startConsuming</a>, <a href="SampleConsumer.html#stopConsuming()">stopConsuming</a></code></div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-org.apache.jmeter.report.processor.SampleProcessor">Methods inherited from interface&nbsp;org.apache.jmeter.report.processor.<a href="SampleProcessor.html" title="interface in org.apache.jmeter.report.processor">SampleProcessor</a></h3>
 <code><a href="SampleProcessor.html#getChannelAttribute(int,java.lang.String)">getChannelAttribute</a>, <a href="SampleProcessor.html#getSampleContext()">getSampleContext</a></code></div>
 </section>
 </li>
 </ul>
 </section>
 <section class="details">
 <ul class="details-list">
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <li>
 <section class="constructor-details" id="constructor-detail">
 <h2>Constructor Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="&lt;init&gt;()">
 <h3>AbstractSampleConsumer</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">AbstractSampleConsumer</span>()</div>
 </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="getDataFromContext(java.lang.String)">
 <h3>getDataFromContext</h3>
 <div class="member-signature"><span class="modifiers">protected final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span>&nbsp;<span class="element-name">getDataFromContext</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;key)</span></div>
 <div class="block">Gets the data identified by the specified key from the current sample
  context</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>key</code> - the key</dd>
 <dt>Returns:</dt>
 <dd>the data</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setDataToContext(java.lang.String,java.lang.Object)">
 <h3>setDataToContext</h3>
 <div class="member-signature"><span class="modifiers">protected final</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setDataToContext</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;key,
  <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;value)</span></div>
 <div class="block">Store data in the current sample context with the specified key
  identifier.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>key</code> - the key</dd>
 <dd><code>value</code> - the value</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getName()">
 <h3>getName</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getName</span>()</div>
 <div class="block">Gets the name of the consumer.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the name of the consumer</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setName(java.lang.String)">
 <h3>setName</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setName</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
 <div class="block">Sets the name of the consumer.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>name</code> - the new name</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getWorkingDirectory()">
 <h3>getWorkingDirectory</h3>
 <div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a></span>&nbsp;<span class="element-name">getWorkingDirectory</span>()</div>
 </section>
 </li>
 <li>
 <section class="detail" id="setSampleContext(org.apache.jmeter.report.processor.SampleContext)">
 <h3>setSampleContext</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setSampleContext</span><wbr><span class="parameters">(<a href="SampleContext.html" title="class in org.apache.jmeter.report.processor">SampleContext</a>&nbsp;sampleContext)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="SampleProcessor.html#setSampleContext(org.apache.jmeter.report.processor.SampleContext)">SampleProcessor</a></code></span></div>
 <div class="block">Set sample context that this consumer should rely on.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="SampleProcessor.html#setSampleContext(org.apache.jmeter.report.processor.SampleContext)">setSampleContext</a></code>&nbsp;in interface&nbsp;<code><a href="SampleProcessor.html" title="interface in org.apache.jmeter.report.processor">SampleProcessor</a></code></dd>
 <dt>Overrides:</dt>
 <dd><code><a href="AbstractSampleProcessor.html#setSampleContext(org.apache.jmeter.report.processor.SampleContext)">setSampleContext</a></code>&nbsp;in class&nbsp;<code><a href="AbstractSampleProcessor.html" title="class in org.apache.jmeter.report.processor">AbstractSampleProcessor</a></code></dd>
 <dt>Parameters:</dt>
 <dd><code>sampleContext</code> - the new sample context</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setSampleConsumers(java.util.List)">
 <h3>setSampleConsumers</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setSampleConsumers</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="SampleConsumer.html" title="interface in org.apache.jmeter.report.processor">SampleConsumer</a>&gt;&nbsp;consumers)</span></div>
 <div class="block">Sets the consumers</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>consumers</code> - for the samples (must not be <code>null</code>)</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="addSampleConsumer(org.apache.jmeter.report.processor.SampleConsumer)">
 <h3>addSampleConsumer</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">addSampleConsumer</span><wbr><span class="parameters">(<a href="SampleConsumer.html" title="interface in org.apache.jmeter.report.processor">SampleConsumer</a>&nbsp;consumer)</span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="setSampleConsumer(org.apache.jmeter.report.processor.SampleConsumer)">
 <h3>setSampleConsumer</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setSampleConsumer</span><wbr><span class="parameters">(<a href="SampleConsumer.html" title="interface in org.apache.jmeter.report.processor">SampleConsumer</a>&nbsp;consumer)</span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="removeSampleConsumer(org.apache.jmeter.report.processor.SampleConsumer)">
 <h3>removeSampleConsumer</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">removeSampleConsumer</span><wbr><span class="parameters">(<a href="SampleConsumer.html" title="interface in org.apache.jmeter.report.processor">SampleConsumer</a>&nbsp;consumer)</span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="setConsumedMetadata(org.apache.jmeter.report.core.SampleMetadata,int)">
 <h3>setConsumedMetadata</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setConsumedMetadata</span><wbr><span class="parameters">(<a href="../core/SampleMetadata.html" title="class in org.apache.jmeter.report.core">SampleMetadata</a>&nbsp;sampleMetadata,
  int&nbsp;channel)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="SampleConsumer.html#setConsumedMetadata(org.apache.jmeter.report.core.SampleMetadata,int)">SampleConsumer</a></code></span></div>
 <div class="block">Set the metadata of samples that will be consumed on the specified
  channel.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="SampleConsumer.html#setConsumedMetadata(org.apache.jmeter.report.core.SampleMetadata,int)">setConsumedMetadata</a></code>&nbsp;in interface&nbsp;<code><a href="SampleConsumer.html" title="interface in org.apache.jmeter.report.processor">SampleConsumer</a></code></dd>
 <dt>Parameters:</dt>
 <dd><code>sampleMetadata</code> - The sample metadata that are being consumed for the
             associated channel</dd>
 <dd><code>channel</code> - The channel whose sample metadata are being defined</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getConsumedMetadata(int)">
 <h3>getConsumedMetadata</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../core/SampleMetadata.html" title="class in org.apache.jmeter.report.core">SampleMetadata</a></span>&nbsp;<span class="element-name">getConsumedMetadata</span><wbr><span class="parameters">(int&nbsp;channel)</span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="getConsumedChannelCount()">
 <h3>getConsumedChannelCount</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getConsumedChannelCount</span>()</div>
 </section>
 </li>
 <li>
 <section class="detail" id="setChannelAttribute(int,java.lang.String,java.lang.Object)">
 <h3>setChannelAttribute</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setChannelAttribute</span><wbr><span class="parameters">(int&nbsp;channel,
  <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;key,
  <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;value)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="SampleProcessor.html#setChannelAttribute(int,java.lang.String,java.lang.Object)">SampleProcessor</a></code></span></div>
 <div class="block">Associate an attribute to the specified channel for this sample processor<br>
  If the attribute already exist, it is replaced.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="SampleProcessor.html#setChannelAttribute(int,java.lang.String,java.lang.Object)">setChannelAttribute</a></code>&nbsp;in interface&nbsp;<code><a href="SampleProcessor.html" title="interface in org.apache.jmeter.report.processor">SampleProcessor</a></code></dd>
 <dt>Overrides:</dt>
 <dd><code><a href="AbstractSampleProcessor.html#setChannelAttribute(int,java.lang.String,java.lang.Object)">setChannelAttribute</a></code>&nbsp;in class&nbsp;<code><a href="AbstractSampleProcessor.html" title="class in org.apache.jmeter.report.processor">AbstractSampleProcessor</a></code></dd>
 <dt>Parameters:</dt>
 <dd><code>channel</code> - The channel number to associate the attribute on</dd>
 <dd><code>key</code> - The attribute key</dd>
 <dd><code>value</code> - The attribute value to be set</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setProducedMetadata(org.apache.jmeter.report.core.SampleMetadata,int)">
 <h3>setProducedMetadata</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setProducedMetadata</span><wbr><span class="parameters">(<a href="../core/SampleMetadata.html" title="class in org.apache.jmeter.report.core">SampleMetadata</a>&nbsp;metadata,
  int&nbsp;channel)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="SampleProducer.html#setProducedMetadata(org.apache.jmeter.report.core.SampleMetadata,int)">SampleProducer</a></code></span></div>
 <div class="block">Set the metadata associated with the specified channel</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="SampleProducer.html#setProducedMetadata(org.apache.jmeter.report.core.SampleMetadata,int)">setProducedMetadata</a></code>&nbsp;in interface&nbsp;<code><a href="SampleProducer.html" title="interface in org.apache.jmeter.report.processor">SampleProducer</a></code></dd>
 <dt>Parameters:</dt>
 <dd><code>metadata</code> - The metadata to be associated to the specified channel</dd>
 <dd><code>channel</code> - The channel whoses metadata are being associated with</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getConsumer(int)">
 <h3>getConsumer</h3>
 <div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="SampleConsumer.html" title="interface in org.apache.jmeter.report.processor">SampleConsumer</a></span>&nbsp;<span class="element-name">getConsumer</span><wbr><span class="parameters">(int&nbsp;i)</span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="startProducing()">
 <h3>startProducing</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">startProducing</span>()</div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="SampleProducer.html#startProducing()">SampleProducer</a></code></span></div>
 <div class="block">Start producing samples, must be invoked before any call to
  <code>produce()</code></div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="SampleProducer.html#startProducing()">startProducing</a></code>&nbsp;in interface&nbsp;<code><a href="SampleProducer.html" title="interface in org.apache.jmeter.report.processor">SampleProducer</a></code></dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="produce(org.apache.jmeter.report.core.Sample,int)">
 <h3>produce</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">produce</span><wbr><span class="parameters">(<a href="../core/Sample.html" title="class in org.apache.jmeter.report.core">Sample</a>&nbsp;s,
  int&nbsp;channel)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="SampleProducer.html#produce(org.apache.jmeter.report.core.Sample,int)">SampleProducer</a></code></span></div>
 <div class="block">Produce a single sample on the specified channel</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="SampleProducer.html#produce(org.apache.jmeter.report.core.Sample,int)">produce</a></code>&nbsp;in interface&nbsp;<code><a href="SampleProducer.html" title="interface in org.apache.jmeter.report.processor">SampleProducer</a></code></dd>
 <dt>Parameters:</dt>
 <dd><code>s</code> - The sample produced</dd>
 <dd><code>channel</code> - The channel on which is produced the sample</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="stopProducing()">
 <h3>stopProducing</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">stopProducing</span>()</div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="SampleProducer.html#stopProducing()">SampleProducer</a></code></span></div>
 <div class="block">Stop producing samples, no <code>produce()</code> call should occur after
  this service has been called.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="SampleProducer.html#stopProducing()">stopProducing</a></code>&nbsp;in interface&nbsp;<code><a href="SampleProducer.html" title="interface in org.apache.jmeter.report.processor">SampleProducer</a></code></dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </main>
 <footer role="contentinfo">
 <hr>
 <p class="legal-copy"><small>Copyright &copy; 1998-2024 Apache Software Foundation. All Rights Reserved.</small></p>
 </footer>
 </div>
 </div>
 </body>
 </html>