| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>HashTreeTraverser (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.jorphan.collections, interface: HashTreeTraverser"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <div class="about-language"><b>Apache JMeter</b></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.jorphan.collections</a></div> |
| <h1 title="Interface HashTreeTraverser" class="title">Interface HashTreeTraverser</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../../jmeter/gui/action/CheckDirty.html" title="class in org.apache.jmeter.gui.action">CheckDirty</a></code>, <code><a href="../../jmeter/validation/ComponentTreeClonerForValidation.html" title="class in org.apache.jmeter.validation">ComponentTreeClonerForValidation</a></code>, <code><a href="../../jmeter/engine/ConvertListeners.html" title="class in org.apache.jmeter.engine">ConvertListeners</a></code>, <code><a href="../../jmeter/threads/FindTestElementsUpToRootTraverser.html" title="class in org.apache.jmeter.threads">FindTestElementsUpToRootTraverser</a></code>, <code><a href="../../jmeter/engine/PreCompiler.html" title="class in org.apache.jmeter.engine">PreCompiler</a></code>, <code><a href="SearchByClass.html" title="class in org.apache.jorphan.collections">SearchByClass</a></code>, <code><a href="../../jmeter/threads/TestCompiler.html" title="class in org.apache.jmeter.threads">TestCompiler</a></code>, <code><a href="../../jmeter/engine/TreeCloner.html" title="class in org.apache.jmeter.engine">TreeCloner</a></code>, <code><a href="../../jmeter/gui/action/validation/TreeClonerForValidation.html" title="class in org.apache.jmeter.gui.action.validation">TreeClonerForValidation</a></code>, <code><a href="../../jmeter/engine/TreeClonerNoTimer.html" title="class in org.apache.jmeter.engine">TreeClonerNoTimer</a></code>, <code><a href="../../jmeter/engine/TurnElementsOn.html" title="class in org.apache.jmeter.engine">TurnElementsOn</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">HashTreeTraverser</span></div> |
| <div class="block">By implementing this interface, a class can easily traverse a HashTree |
| object, and be notified via callbacks of certain events. There are three such |
| events: |
| <ol> |
| <li>When a node is first encountered, the traverser's |
| <a href="#addNode(java.lang.Object,org.apache.jorphan.collections.HashTree)"><code>addNode(Object,HashTree)</code></a> method is called. It is handed the object |
| at that node, and the entire sub-tree of the node.</li> |
| <li>When a leaf node is encountered, the traverser is notified that a full |
| path has been finished via the <a href="#processPath()"><code>processPath()</code></a> method. It is the |
| traversing class's responsibility to know the path that has just finished |
| (this can be done by keeping a simple stack of all added nodes).</li> |
| <li>When a node is retraced, the traverser's <a href="#subtractNode()"><code>subtractNode()</code></a> is |
| called. Again, it is the traverser's responsibility to know which node has |
| been retraced.</li> |
| </ol> |
| To summarize, as the traversal goes down a tree path, nodes are added. When |
| the end of the path is reached, the <a href="#processPath()"><code>processPath()</code></a> call is sent. As |
| the traversal backs up, nodes are subtracted. |
| <p> |
| The traversal is a depth-first traversal.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="HashTree.html" title="class in org.apache.jorphan.collections"><code>HashTree</code></a></li> |
| <li><a href="SearchByClass.html" title="class in org.apache.jorphan.collections"><code>SearchByClass</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#addNode(java.lang.Object,org.apache.jorphan.collections.HashTree)" class="member-name-link">addNode</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> node, |
| <a href="HashTree.html" title="class in org.apache.jorphan.collections">HashTree</a> subTree)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">The tree traverses itself depth-first, calling addNode for each object it |
| encounters as it goes.</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="#processPath()" class="member-name-link">processPath</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Process path is called when a leaf is reached.</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="#subtractNode()" class="member-name-link">subtractNode</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Indicates traversal has moved up a step, and the visitor should remove |
| the top node from its stack structure.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="addNode(java.lang.Object,org.apache.jorphan.collections.HashTree)"> |
| <h3>addNode</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">addNode</span><wbr><span class="parameters">(<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> node, |
| <a href="HashTree.html" title="class in org.apache.jorphan.collections">HashTree</a> subTree)</span></div> |
| <div class="block">The tree traverses itself depth-first, calling addNode for each object it |
| encounters as it goes. This is a callback method, and should not be |
| called except by a HashTree during traversal.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>node</code> - the node currently encountered</dd> |
| <dd><code>subTree</code> - the HashTree under the node encountered</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="subtractNode()"> |
| <h3>subtractNode</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">subtractNode</span>()</div> |
| <div class="block">Indicates traversal has moved up a step, and the visitor should remove |
| the top node from its stack structure. This is a callback method, and |
| should not be called except by a HashTree during traversal.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="processPath()"> |
| <h3>processPath</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">processPath</span>()</div> |
| <div class="block">Process path is called when a leaf is reached. If a visitor wishes to |
| generate Lists of path elements to each leaf, it should keep a Stack data |
| structure of nodes passed to it with addNode, and removing top items for |
| every <a href="#subtractNode()"><code>subtractNode()</code></a> call. This is a callback method, and should |
| not be called except by a HashTree during traversal.</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> |