javadocAggregate/org/apache/calcite/linq4j/Enumerator.html - calcite-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
 <title>Enumerator (Apache Calcite 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.calcite.linq4j, interface: Enumerator">
 <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 Calcite</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>Constr&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>Constr&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.calcite.linq4j</a></div>
 <h1 title="Interface Enumerator" class="title">Interface Enumerator&lt;T&gt;</h1>
 </div>
 <section class="class-description" id="class-description">
 <dl class="notes">
 <dt>Type Parameters:</dt>
 <dd><code>T</code> - Element type</dd>
 </dl>
 <dl class="notes">
 <dt>All Superinterfaces:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code></dd>
 </dl>
 <dl class="notes">
 <dt>All Known Implementing Classes:</dt>
 <dd><code><a href="CartesianProductEnumerator.html" title="class in org.apache.calcite.linq4j">CartesianProductEnumerator</a></code>, <code><a href="../adapter/file/CsvEnumerator.html" title="class in org.apache.calcite.adapter.file">CsvEnumerator</a></code>, <code><a href="DelegatingEnumerator.html" title="class in org.apache.calcite.linq4j">DelegatingEnumerator</a></code>, <code><a href="../adapter/geode/simple/GeodeSimpleEnumerator.html" title="class in org.apache.calcite.adapter.geode.simple">GeodeSimpleEnumerator</a></code>, <code><a href="../adapter/file/JsonEnumerator.html" title="class in org.apache.calcite.adapter.file">JsonEnumerator</a></code>, <code><a href="../adapter/kafka/KafkaMessageEnumerator.html" title="class in org.apache.calcite.adapter.kafka">KafkaMessageEnumerator</a></code>, <code><a href="MemoryEnumerator.html" title="class in org.apache.calcite.linq4j">MemoryEnumerator</a></code>, <code><a href="../adapter/splunk/search/SplunkConnectionImpl.SplunkResultEnumerator.html" title="class in org.apache.calcite.adapter.splunk.search">SplunkConnectionImpl.SplunkResultEnumerator</a></code>, <code><a href="TransformedEnumerator.html" title="class in org.apache.calcite.linq4j">TransformedEnumerator</a></code></dd>
 </dl>
 <hr>
 <div class="type-signature"><span class="annotations">@Covariant(0)
 </span><span class="modifiers">public interface </span><span class="element-name type-name-label">Enumerator&lt;T&gt;</span><span class="extends-implements">
 extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></span></div>
 <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/en/java/javase/17/docs/api/java.base/java/util/ConcurrentModificationException.html" title="class or interface in java.util" class="external-link"><code>ConcurrentModificationException</code></a>.</div>
 </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="#close()" class="member-name-link">close</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Closes this enumerable and releases resources.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Enumerator.html" title="type parameter in Enumerator">T</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#current()" class="member-name-link">current</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Gets the current element in the collection.</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="#moveNext()" class="member-name-link">moveNext</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Advances the enumerator to the next element of the collection.</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="#reset()" class="member-name-link">reset</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Sets the enumerator to its initial position, which is before the first
  element in the collection.</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="current()">
 <h3>current</h3>
 <div class="member-signature"><span class="return-type"><a href="Enumerator.html" title="type parameter in Enumerator">T</a></span>&nbsp;<span class="element-name">current</span>()</div>
 <div class="block">Gets the current element in the collection.

  <p>After an enumerator is created or after the <a href="#reset()"><code>reset()</code></a> method is
  called, the <a href="#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/en/java/javase/17/docs/api/java.base/java/util/NoSuchElementException.html" title="class or interface in java.util" class="external-link"><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/en/java/javase/17/docs/api/java.base/java/util/ConcurrentModificationException.html" title="class or interface in java.util" class="external-link"><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 class="notes">
 <dt>Returns:</dt>
 <dd>Current element</dd>
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/ConcurrentModificationException.html" title="class or interface in java.util" class="external-link">ConcurrentModificationException</a></code> - if collection
           has been modified</dd>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/NoSuchElementException.html" title="class or interface in java.util" class="external-link">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>
 </section>
 </li>
 <li>
 <section class="detail" id="moveNext()">
 <h3>moveNext</h3>
 <div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">moveNext</span>()</div>
 <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="#reset()"><code>reset()</code></a> may,
  at the discretion of the implementation, throw a
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/ConcurrentModificationException.html" title="class or interface in java.util" class="external-link"><code>ConcurrentModificationException</code></a>.</div>
 <dl class="notes">
 <dt>Returns:</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>
 </section>
 </li>
 <li>
 <section class="detail" id="reset()">
 <h3>reset</h3>
 <div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">reset</span>()</div>
 <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="#moveNext()"><code>moveNext()</code></a> or <code>reset</code> may,
  at the discretion of the implementation, throw a
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/ConcurrentModificationException.html" title="class or interface in java.util" class="external-link"><code>ConcurrentModificationException</code></a>.

  <p>This method is optional; it may throw
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang" class="external-link"><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="#moveNext()"><code>moveNext()</code></a> and
  <a href="#current()"><code>current()</code></a>.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="close()">
 <h3>close</h3>
 <div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">close</span>()</div>
 <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 class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html#close()" title="class or interface in java.lang" class="external-link">close</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</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; 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p>
 </footer>
 </div>
 </div>
 </body>
 </html>
	<!DOCTYPE HTML>
	<html lang="en">
	<head>
	<!-- Generated by javadoc (17) -->
	<title>Enumerator (Apache Calcite 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.calcite.linq4j, interface: Enumerator">
	<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 Calcite</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.calcite.linq4j</a></div>
	<h1 title="Interface Enumerator" class="title">Interface Enumerator<T></h1>
	</div>
	<section class="class-description" id="class-description">
	<dl class="notes">
	<dt>Type Parameters:</dt>
	<dd><code>T</code> - Element type</dd>
	</dl>
	<dl class="notes">
	<dt>All Superinterfaces:</dt>
	<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code></dd>
	</dl>
	<dl class="notes">
	<dt>All Known Implementing Classes:</dt>
	<dd><code><a href="CartesianProductEnumerator.html" title="class in org.apache.calcite.linq4j">CartesianProductEnumerator</a></code>, <code><a href="../adapter/file/CsvEnumerator.html" title="class in org.apache.calcite.adapter.file">CsvEnumerator</a></code>, <code><a href="DelegatingEnumerator.html" title="class in org.apache.calcite.linq4j">DelegatingEnumerator</a></code>, <code><a href="../adapter/geode/simple/GeodeSimpleEnumerator.html" title="class in org.apache.calcite.adapter.geode.simple">GeodeSimpleEnumerator</a></code>, <code><a href="../adapter/file/JsonEnumerator.html" title="class in org.apache.calcite.adapter.file">JsonEnumerator</a></code>, <code><a href="../adapter/kafka/KafkaMessageEnumerator.html" title="class in org.apache.calcite.adapter.kafka">KafkaMessageEnumerator</a></code>, <code><a href="MemoryEnumerator.html" title="class in org.apache.calcite.linq4j">MemoryEnumerator</a></code>, <code><a href="../adapter/splunk/search/SplunkConnectionImpl.SplunkResultEnumerator.html" title="class in org.apache.calcite.adapter.splunk.search">SplunkConnectionImpl.SplunkResultEnumerator</a></code>, <code><a href="TransformedEnumerator.html" title="class in org.apache.calcite.linq4j">TransformedEnumerator</a></code></dd>
	</dl>
	<hr>
	<div class="type-signature"><span class="annotations">@Covariant(0)
	</span><span class="modifiers">public interface </span><span class="element-name type-name-label">Enumerator<T></span><span class="extends-implements">
	extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></span></div>
	<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/en/java/javase/17/docs/api/java.base/java/util/ConcurrentModificationException.html" title="class or interface in java.util" class="external-link"><code>ConcurrentModificationException</code></a>.</div>
	</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="#close()" class="member-name-link">close</a>()</code></div>
	<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
	<div class="block">Closes this enumerable and releases resources.</div>
	</div>
	<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Enumerator.html" title="type parameter in Enumerator">T</a></code></div>
	<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#current()" class="member-name-link">current</a>()</code></div>
	<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
	<div class="block">Gets the current element in the collection.</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="#moveNext()" class="member-name-link">moveNext</a>()</code></div>
	<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
	<div class="block">Advances the enumerator to the next element of the collection.</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="#reset()" class="member-name-link">reset</a>()</code></div>
	<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
	<div class="block">Sets the enumerator to its initial position, which is before the first
	element in the collection.</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="current()">
	<h3>current</h3>
	<div class="member-signature"><span class="return-type"><a href="Enumerator.html" title="type parameter in Enumerator">T</a></span> <span class="element-name">current</span>()</div>
	<div class="block">Gets the current element in the collection.

	<p>After an enumerator is created or after the <a href="#reset()"><code>reset()</code></a> method is
	called, the <a href="#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/en/java/javase/17/docs/api/java.base/java/util/NoSuchElementException.html" title="class or interface in java.util" class="external-link"><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/en/java/javase/17/docs/api/java.base/java/util/ConcurrentModificationException.html" title="class or interface in java.util" class="external-link"><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 class="notes">
	<dt>Returns:</dt>
	<dd>Current element</dd>
	<dt>Throws:</dt>
	<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/ConcurrentModificationException.html" title="class or interface in java.util" class="external-link">ConcurrentModificationException</a></code> - if collection
	has been modified</dd>
	<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/NoSuchElementException.html" title="class or interface in java.util" class="external-link">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>
	</section>
	</li>
	<li>
	<section class="detail" id="moveNext()">
	<h3>moveNext</h3>
	<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">moveNext</span>()</div>
	<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="#reset()"><code>reset()</code></a> may,
	at the discretion of the implementation, throw a
	<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/ConcurrentModificationException.html" title="class or interface in java.util" class="external-link"><code>ConcurrentModificationException</code></a>.</div>
	<dl class="notes">
	<dt>Returns:</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>
	</section>
	</li>
	<li>
	<section class="detail" id="reset()">
	<h3>reset</h3>
	<div class="member-signature"><span class="return-type">void</span> <span class="element-name">reset</span>()</div>
	<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="#moveNext()"><code>moveNext()</code></a> or <code>reset</code> may,
	at the discretion of the implementation, throw a
	<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/ConcurrentModificationException.html" title="class or interface in java.util" class="external-link"><code>ConcurrentModificationException</code></a>.

	<p>This method is optional; it may throw
	<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang" class="external-link"><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="#moveNext()"><code>moveNext()</code></a> and
	<a href="#current()"><code>current()</code></a>.</div>
	</section>
	</li>
	<li>
	<section class="detail" id="close()">
	<h3>close</h3>
	<div class="member-signature"><span class="return-type">void</span> <span class="element-name">close</span>()</div>
	<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 class="notes">
	<dt>Specified by:</dt>
	<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html#close()" title="class or interface in java.lang" class="external-link">close</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</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 © 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p>
	</footer>
	</div>
	</div>
	</body>
	</html>