blob: 2c7d6cda1e1cf6b8d8d4f1652c737e8df7fdd30e [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>CloseableIterable</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CloseableIterable";
}
}
catch(err) {
}
//-->
var data = {"i0":1,"i1":1,"i2":1,"i3":1,"i4":6,"i5":1,"i6":1,"i7":1};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.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>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.iceberg.io</a></div>
<h2 title="Interface CloseableIterable" class="title">Interface CloseableIterable&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><code>java.lang.AutoCloseable</code>, <code>java.io.Closeable</code>, <code>java.lang.Iterable&lt;T&gt;</code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../avro/AvroIterable.html" title="class in org.apache.iceberg.avro">AvroIterable</a></code>, <code><a href="CloseableIterable.ConcatCloseableIterable.html" title="class in org.apache.iceberg.io">CloseableIterable.ConcatCloseableIterable</a></code>, <code><a href="../ManifestReader.html" title="class in org.apache.iceberg">ManifestReader</a></code>, <code><a href="../util/ParallelIterable.html" title="class in org.apache.iceberg.util">ParallelIterable</a></code>, <code><a href="../parquet/ParquetIterable.html" title="class in org.apache.iceberg.parquet">ParquetIterable</a></code>, <code><a href="../parquet/ParquetReader.html" title="class in org.apache.iceberg.parquet">ParquetReader</a></code>, <code><a href="../util/SortedMerge.html" title="class in org.apache.iceberg.util">SortedMerge</a></code>, <code><a href="../parquet/VectorizedParquetReader.html" title="class in org.apache.iceberg.parquet">VectorizedParquetReader</a></code>, <code><a href="../arrow/vectorized/VectorizedTableScanIterable.html" title="class in org.apache.iceberg.arrow.vectorized">VectorizedTableScanIterable</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">CloseableIterable&lt;T&gt;</span>
extends java.lang.Iterable&lt;T&gt;, java.io.Closeable</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="CloseableIterable.ConcatCloseableIterable.html" title="class in org.apache.iceberg.io">CloseableIterable.ConcatCloseableIterable</a>&lt;<a href="CloseableIterable.ConcatCloseableIterable.html" title="type parameter in CloseableIterable.ConcatCloseableIterable">E</a>&gt;</span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static &lt;E&gt;&nbsp;<a href="CloseableIterable.html" title="interface in org.apache.iceberg.io">CloseableIterable</a>&lt;E&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#combine(java.lang.Iterable,java.io.Closeable)">combine</a></span>&#8203;(java.lang.Iterable&lt;E&gt;&nbsp;iterable,
java.io.Closeable&nbsp;closeable)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static &lt;E&gt;&nbsp;<a href="CloseableIterable.html" title="interface in org.apache.iceberg.io">CloseableIterable</a>&lt;E&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#concat(java.lang.Iterable)">concat</a></span>&#8203;(java.lang.Iterable&lt;<a href="CloseableIterable.html" title="interface in org.apache.iceberg.io">CloseableIterable</a>&lt;E&gt;&gt;&nbsp;iterable)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static &lt;E&gt;&nbsp;<a href="CloseableIterable.html" title="interface in org.apache.iceberg.io">CloseableIterable</a>&lt;E&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#empty()">empty</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static &lt;E&gt;&nbsp;<a href="CloseableIterable.html" title="interface in org.apache.iceberg.io">CloseableIterable</a>&lt;E&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#filter(org.apache.iceberg.io.CloseableIterable,java.util.function.Predicate)">filter</a></span>&#8203;(<a href="CloseableIterable.html" title="interface in org.apache.iceberg.io">CloseableIterable</a>&lt;E&gt;&nbsp;iterable,
java.util.function.Predicate&lt;E&gt;&nbsp;pred)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="CloseableIterator.html" title="interface in org.apache.iceberg.io">CloseableIterator</a>&lt;<a href="CloseableIterable.html" title="type parameter in CloseableIterable">T</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#iterator()">iterator</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns an closeable iterator over elements of type <code>T</code>.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static &lt;I,&#8203;O&gt;<br><a href="CloseableIterable.html" title="interface in org.apache.iceberg.io">CloseableIterable</a>&lt;O&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#transform(org.apache.iceberg.io.CloseableIterable,java.util.function.Function)">transform</a></span>&#8203;(<a href="CloseableIterable.html" title="interface in org.apache.iceberg.io">CloseableIterable</a>&lt;I&gt;&nbsp;iterable,
java.util.function.Function&lt;I,&#8203;O&gt;&nbsp;transform)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static &lt;E&gt;&nbsp;<a href="CloseableIterable.html" title="interface in org.apache.iceberg.io">CloseableIterable</a>&lt;E&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withNoopClose(E)">withNoopClose</a></span>&#8203;(E&nbsp;entry)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static &lt;E&gt;&nbsp;<a href="CloseableIterable.html" title="interface in org.apache.iceberg.io">CloseableIterable</a>&lt;E&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withNoopClose(java.lang.Iterable)">withNoopClose</a></span>&#8203;(java.lang.Iterable&lt;E&gt;&nbsp;iterable)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.io.Closeable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;java.io.Closeable</h3>
<code>close</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Iterable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;java.lang.Iterable</h3>
<code>forEach, spliterator</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="iterator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>iterator</h4>
<pre class="methodSignature"><a href="CloseableIterator.html" title="interface in org.apache.iceberg.io">CloseableIterator</a>&lt;<a href="CloseableIterable.html" title="type parameter in CloseableIterable">T</a>&gt;&nbsp;iterator()</pre>
<div class="block">Returns an closeable iterator over elements of type <code>T</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>iterator</code>&nbsp;in interface&nbsp;<code>java.lang.Iterable&lt;<a href="CloseableIterable.html" title="type parameter in CloseableIterable">T</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an <a href="CloseableIterator.html" title="interface in org.apache.iceberg.io"><code>CloseableIterator</code></a>.</dd>
</dl>
</li>
</ul>
<a id="withNoopClose(java.lang.Object)">
<!-- -->
</a><a id="withNoopClose(E)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withNoopClose</h4>
<pre class="methodSignature">static&nbsp;&lt;E&gt;&nbsp;<a href="CloseableIterable.html" title="interface in org.apache.iceberg.io">CloseableIterable</a>&lt;E&gt;&nbsp;withNoopClose&#8203;(E&nbsp;entry)</pre>
</li>
</ul>
<a id="withNoopClose(java.lang.Iterable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withNoopClose</h4>
<pre class="methodSignature">static&nbsp;&lt;E&gt;&nbsp;<a href="CloseableIterable.html" title="interface in org.apache.iceberg.io">CloseableIterable</a>&lt;E&gt;&nbsp;withNoopClose&#8203;(java.lang.Iterable&lt;E&gt;&nbsp;iterable)</pre>
</li>
</ul>
<a id="empty()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>empty</h4>
<pre class="methodSignature">static&nbsp;&lt;E&gt;&nbsp;<a href="CloseableIterable.html" title="interface in org.apache.iceberg.io">CloseableIterable</a>&lt;E&gt;&nbsp;empty()</pre>
</li>
</ul>
<a id="combine(java.lang.Iterable,java.io.Closeable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>combine</h4>
<pre class="methodSignature">static&nbsp;&lt;E&gt;&nbsp;<a href="CloseableIterable.html" title="interface in org.apache.iceberg.io">CloseableIterable</a>&lt;E&gt;&nbsp;combine&#8203;(java.lang.Iterable&lt;E&gt;&nbsp;iterable,
java.io.Closeable&nbsp;closeable)</pre>
</li>
</ul>
<a id="filter(org.apache.iceberg.io.CloseableIterable,java.util.function.Predicate)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>filter</h4>
<pre class="methodSignature">static&nbsp;&lt;E&gt;&nbsp;<a href="CloseableIterable.html" title="interface in org.apache.iceberg.io">CloseableIterable</a>&lt;E&gt;&nbsp;filter&#8203;(<a href="CloseableIterable.html" title="interface in org.apache.iceberg.io">CloseableIterable</a>&lt;E&gt;&nbsp;iterable,
java.util.function.Predicate&lt;E&gt;&nbsp;pred)</pre>
</li>
</ul>
<a id="transform(org.apache.iceberg.io.CloseableIterable,java.util.function.Function)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>transform</h4>
<pre class="methodSignature">static&nbsp;&lt;I,&#8203;O&gt;&nbsp;<a href="CloseableIterable.html" title="interface in org.apache.iceberg.io">CloseableIterable</a>&lt;O&gt;&nbsp;transform&#8203;(<a href="CloseableIterable.html" title="interface in org.apache.iceberg.io">CloseableIterable</a>&lt;I&gt;&nbsp;iterable,
java.util.function.Function&lt;I,&#8203;O&gt;&nbsp;transform)</pre>
</li>
</ul>
<a id="concat(java.lang.Iterable)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>concat</h4>
<pre class="methodSignature">static&nbsp;&lt;E&gt;&nbsp;<a href="CloseableIterable.html" title="interface in org.apache.iceberg.io">CloseableIterable</a>&lt;E&gt;&nbsp;concat&#8203;(java.lang.Iterable&lt;<a href="CloseableIterable.html" title="interface in org.apache.iceberg.io">CloseableIterable</a>&lt;E&gt;&gt;&nbsp;iterable)</pre>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.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>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>