| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Enumerator (Apache Calcite calcite API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Enumerator (Apache Calcite calcite API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">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">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/calcite/linq4j/EnumerableDefaults.html" title="class in org.apache.calcite.linq4j"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/calcite/linq4j/ExtendedEnumerable.html" title="interface in org.apache.calcite.linq4j"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/calcite/linq4j/Enumerator.html" target="_top">Frames</a></li> |
| <li><a href="Enumerator.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.calcite.linq4j</div> |
| <h2 title="Interface Enumerator" class="title">Interface Enumerator<T></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Element type</dd> |
| </dl> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/calcite/linq4j/CartesianProductEnumerator.html" title="class in org.apache.calcite.linq4j">CartesianProductEnumerator</a>, <a href="../../../../org/apache/calcite/linq4j/DelegatingEnumerator.html" title="class in org.apache.calcite.linq4j">DelegatingEnumerator</a>, <a href="../../../../org/apache/calcite/adapter/geode/simple/GeodeSimpleEnumerator.html" title="class in org.apache.calcite.adapter.geode.simple">GeodeSimpleEnumerator</a>, <a href="../../../../org/apache/calcite/adapter/csv/JsonEnumerator.html" title="class in org.apache.calcite.adapter.csv">JsonEnumerator</a>, <a href="../../../../org/apache/calcite/adapter/kafka/KafkaMessageEnumerator.html" title="class in org.apache.calcite.adapter.kafka">KafkaMessageEnumerator</a>, <a href="../../../../org/apache/calcite/linq4j/MemoryEnumerator.html" title="class in org.apache.calcite.linq4j">MemoryEnumerator</a>, <a href="../../../../org/apache/calcite/adapter/splunk/search/SplunkConnectionImpl.SplunkResultEnumerator.html" title="class in org.apache.calcite.adapter.splunk.search">SplunkConnectionImpl.SplunkResultEnumerator</a>, <a href="../../../../org/apache/calcite/linq4j/TransformedEnumerator.html" title="class in org.apache.calcite.linq4j">TransformedEnumerator</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Enumerator<T></span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></pre> |
| <div class="block">Supports a simple iteration over a collection. |
| |
| <p>Analogous to LINQ's System.Collections.Enumerator. Unlike LINQ, if the |
| underlying collection has been modified it is only optional that an |
| implementation of the Enumerator interface detects it and throws a |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ConcurrentModificationException.html?is-external=true" title="class or interface in java.util"><code>ConcurrentModificationException</code></a>.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/linq4j/Enumerator.html#close--">close</a></span>()</code> |
| <div class="block">Closes this enumerable and releases resources.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/calcite/linq4j/Enumerator.html" title="type parameter in Enumerator">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/linq4j/Enumerator.html#current--">current</a></span>()</code> |
| <div class="block">Gets the current element in the collection.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/linq4j/Enumerator.html#moveNext--">moveNext</a></span>()</code> |
| <div class="block">Advances the enumerator to the next element of the collection.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/linq4j/Enumerator.html#reset--">reset</a></span>()</code> |
| <div class="block">Sets the enumerator to its initial position, which is before the first |
| element in the collection.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="current--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>current</h4> |
| <pre><a href="../../../../org/apache/calcite/linq4j/Enumerator.html" title="type parameter in Enumerator">T</a> current()</pre> |
| <div class="block">Gets the current element in the collection. |
| |
| <p>After an enumerator is created or after the <a href="../../../../org/apache/calcite/linq4j/Enumerator.html#reset--"><code>reset()</code></a> method is |
| called, the <a href="../../../../org/apache/calcite/linq4j/Enumerator.html#moveNext--"><code>moveNext()</code></a> method must be called to advance the |
| enumerator to the first element of the collection before reading the |
| value of the <code>current</code> property; otherwise, <code>current</code> is |
| undefined. |
| |
| <p>This method also throws <a href="https://docs.oracle.com/javase/8/docs/api/java/util/NoSuchElementException.html?is-external=true" title="class or interface in java.util"><code>NoSuchElementException</code></a> if |
| the last call to <code>moveNext</code> returned <code>false</code>, which indicates |
| the end of the collection. |
| |
| <p>This method does not move the position of the enumerator, and |
| consecutive calls to <code>current</code> return the same object until either |
| <code>moveNext</code> or <code>reset</code> is called. |
| |
| <p>An enumerator remains valid as long as the collection remains |
| unchanged. If changes are made to the collection, such as adding, |
| modifying, or deleting elements, the enumerator is irrecoverably |
| invalidated. The next call to <code>moveNext</code> or <code>reset</code> may, |
| at the discretion of the implementation, throw a |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ConcurrentModificationException.html?is-external=true" title="class or interface in java.util"><code>ConcurrentModificationException</code></a>. If the collection is |
| modified between <code>moveNext</code> and <code>current</code>, <code>current</code> |
| returns the element that it is set to, even if the enumerator is already |
| invalidated.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Current element</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/ConcurrentModificationException.html?is-external=true" title="class or interface in java.util">ConcurrentModificationException</a></code> - if collection |
| has been modified</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/NoSuchElementException.html?is-external=true" title="class or interface in java.util">NoSuchElementException</a></code> - if <code>moveToNext</code> |
| has not been called, has not been called since the most |
| recent call to <code>reset</code>, or returned false</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="moveNext--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>moveNext</h4> |
| <pre>boolean moveNext()</pre> |
| <div class="block">Advances the enumerator to the next element of the collection. |
| |
| <p>After an enumerator is created or after the <code>reset</code> method is |
| called, an enumerator is positioned before the first element of the |
| collection, and the first call to the <code>moveNext</code> method moves the |
| enumerator over the first element of the collection. |
| |
| <p>If <code>moveNext</code> passes the end of the collection, the enumerator |
| is positioned after the last element in the collection and |
| <code>moveNext</code> returns <code>false</code>. When the enumerator is at this |
| position, subsequent calls to <code>moveNext</code> also return <code>false</code> |
| until <code>#reset</code> is called. |
| |
| <p>An enumerator remains valid as long as the collection remains |
| unchanged. If changes are made to the collection, such as adding, |
| modifying, or deleting elements, the enumerator is irrecoverably |
| invalidated. The next call to <code>moveNext</code> or <a href="../../../../org/apache/calcite/linq4j/Enumerator.html#reset--"><code>reset()</code></a> may, |
| at the discretion of the implementation, throw a |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ConcurrentModificationException.html?is-external=true" title="class or interface in java.util"><code>ConcurrentModificationException</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the enumerator was successfully advanced to the |
| next element; <code>false</code> if the enumerator has passed the end of |
| the collection</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="reset--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reset</h4> |
| <pre>void reset()</pre> |
| <div class="block">Sets the enumerator to its initial position, which is before the first |
| element in the collection. |
| |
| <p>An enumerator remains valid as long as the collection remains |
| unchanged. If changes are made to the collection, such as adding, |
| modifying, or deleting elements, the enumerator is irrecoverably |
| invalidated. The next call to <a href="../../../../org/apache/calcite/linq4j/Enumerator.html#moveNext--"><code>moveNext()</code></a> or <code>reset</code> may, |
| at the discretion of the implementation, throw a |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/ConcurrentModificationException.html?is-external=true" title="class or interface in java.util"><code>ConcurrentModificationException</code></a>. |
| |
| <p>This method is optional; it may throw |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang"><code>UnsupportedOperationException</code></a>. |
| |
| <p><b>Notes to Implementers</b> |
| |
| <p>All calls to Reset must result in the same state for the enumerator. |
| The preferred implementation is to move the enumerator to the beginning |
| of the collection, before the first element. This invalidates the |
| enumerator if the collection has been modified since the enumerator was |
| created, which is consistent with <a href="../../../../org/apache/calcite/linq4j/Enumerator.html#moveNext--"><code>moveNext()</code></a> and |
| <a href="../../../../org/apache/calcite/linq4j/Enumerator.html#current--"><code>current()</code></a>.</div> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>void close()</pre> |
| <div class="block">Closes this enumerable and releases resources. |
| |
| <p>This method is idempotent. Calling it multiple times has the same effect |
| as calling it once.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">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">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/calcite/linq4j/EnumerableDefaults.html" title="class in org.apache.calcite.linq4j"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/calcite/linq4j/ExtendedEnumerable.html" title="interface in org.apache.calcite.linq4j"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/calcite/linq4j/Enumerator.html" target="_top">Frames</a></li> |
| <li><a href="Enumerator.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p> |
| </body> |
| </html> |