| <!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 --> |
| <title>PrefetchableIterators (Apache Beam 2.47.0)</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="PrefetchableIterators (Apache Beam 2.47.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete 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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/beam/sdk/fn/stream/PrefetchableIterator.html" title="interface in org.apache.beam.sdk.fn.stream"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/fn/stream/SynchronizedStreamObserver.html" title="class in org.apache.beam.sdk.fn.stream"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/fn/stream/PrefetchableIterators.html" target="_top">Frames</a></li> |
| <li><a href="PrefetchableIterators.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.beam.sdk.fn.stream</div> |
| <h2 title="Class PrefetchableIterators" class="title">Class PrefetchableIterators</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.fn.stream.PrefetchableIterators</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">PrefetchableIterators</span> |
| extends java.lang.Object</pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/fn/stream/PrefetchableIterators.html#PrefetchableIterators--">PrefetchableIterators</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== 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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>static <T> <a href="../../../../../../org/apache/beam/sdk/fn/stream/PrefetchableIterator.html" title="interface in org.apache.beam.sdk.fn.stream">PrefetchableIterator</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/fn/stream/PrefetchableIterators.html#concat-java.util.Iterator...-">concat</a></span>(java.util.Iterator<T>... iterators)</code> |
| <div class="block">Concatentates the <code>Iterator</code>s.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <T> <a href="../../../../../../org/apache/beam/sdk/fn/stream/PrefetchableIterator.html" title="interface in org.apache.beam.sdk.fn.stream">PrefetchableIterator</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/fn/stream/PrefetchableIterators.html#concatIterators-java.util.Iterator-">concatIterators</a></span>(java.util.Iterator<java.util.Iterator<T>> iterators)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <T> <a href="../../../../../../org/apache/beam/sdk/fn/stream/PrefetchableIterator.html" title="interface in org.apache.beam.sdk.fn.stream">PrefetchableIterator</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/fn/stream/PrefetchableIterators.html#emptyIterator--">emptyIterator</a></span>()</code> |
| <div class="block">Returns an empty <a href="../../../../../../org/apache/beam/sdk/fn/stream/PrefetchableIterator.html" title="interface in org.apache.beam.sdk.fn.stream"><code>PrefetchableIterator</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <T> <a href="../../../../../../org/apache/beam/sdk/fn/stream/PrefetchableIterator.html" title="interface in org.apache.beam.sdk.fn.stream">PrefetchableIterator</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/fn/stream/PrefetchableIterators.html#fromArray-T...-">fromArray</a></span>(T... values)</code> |
| <div class="block">Returns a <a href="../../../../../../org/apache/beam/sdk/fn/stream/PrefetchableIterator.html" title="interface in org.apache.beam.sdk.fn.stream"><code>PrefetchableIterator</code></a> over the specified values.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="PrefetchableIterators--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>PrefetchableIterators</h4> |
| <pre>public PrefetchableIterators()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="emptyIterator--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>emptyIterator</h4> |
| <pre>public static <T> <a href="../../../../../../org/apache/beam/sdk/fn/stream/PrefetchableIterator.html" title="interface in org.apache.beam.sdk.fn.stream">PrefetchableIterator</a><T> emptyIterator()</pre> |
| <div class="block">Returns an empty <a href="../../../../../../org/apache/beam/sdk/fn/stream/PrefetchableIterator.html" title="interface in org.apache.beam.sdk.fn.stream"><code>PrefetchableIterator</code></a>.</div> |
| </li> |
| </ul> |
| <a name="fromArray-java.lang.Object:A-"> |
| <!-- --> |
| </a><a name="fromArray-T...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fromArray</h4> |
| <pre>public static <T> <a href="../../../../../../org/apache/beam/sdk/fn/stream/PrefetchableIterator.html" title="interface in org.apache.beam.sdk.fn.stream">PrefetchableIterator</a><T> fromArray(T... values)</pre> |
| <div class="block">Returns a <a href="../../../../../../org/apache/beam/sdk/fn/stream/PrefetchableIterator.html" title="interface in org.apache.beam.sdk.fn.stream"><code>PrefetchableIterator</code></a> over the specified values. |
| |
| <p><a href="../../../../../../org/apache/beam/sdk/fn/stream/PrefetchableIterator.html#prefetch--"><code>PrefetchableIterator.prefetch()</code></a> is a no-op and <a href="../../../../../../org/apache/beam/sdk/fn/stream/PrefetchableIterator.html#isReady--"><code>PrefetchableIterator.isReady()</code></a> always returns true.</div> |
| </li> |
| </ul> |
| <a name="concatIterators-java.util.Iterator-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>concatIterators</h4> |
| <pre>public static <T> <a href="../../../../../../org/apache/beam/sdk/fn/stream/PrefetchableIterator.html" title="interface in org.apache.beam.sdk.fn.stream">PrefetchableIterator</a><T> concatIterators(java.util.Iterator<java.util.Iterator<T>> iterators)</pre> |
| </li> |
| </ul> |
| <a name="concat-java.util.Iterator...-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>concat</h4> |
| <pre>public static <T> <a href="../../../../../../org/apache/beam/sdk/fn/stream/PrefetchableIterator.html" title="interface in org.apache.beam.sdk.fn.stream">PrefetchableIterator</a><T> concat(java.util.Iterator<T>... iterators)</pre> |
| <div class="block">Concatentates the <code>Iterator</code>s. |
| |
| <p><code>Iterable</code>s are first converted into a <a href="../../../../../../org/apache/beam/sdk/fn/stream/PrefetchableIterable.html" title="interface in org.apache.beam.sdk.fn.stream"><code>PrefetchableIterable</code></a> via <a href="../../../../../../org/apache/beam/sdk/fn/stream/PrefetchableIterators.html#maybePrefetchable-java.util.Iterator-"><code>maybePrefetchable(java.util.Iterator<T>)</code></a>. |
| |
| <p>The returned <a href="../../../../../../org/apache/beam/sdk/fn/stream/PrefetchableIterable.html" title="interface in org.apache.beam.sdk.fn.stream"><code>PrefetchableIterable</code></a> ensures that iterators which are returned |
| guarantee that <a href="../../../../../../org/apache/beam/sdk/fn/stream/PrefetchableIterator.html#isReady--"><code>PrefetchableIterator.isReady()</code></a> always advances till it finds an <code>Iterable</code> that is not <a href="../../../../../../org/apache/beam/sdk/fn/stream/PrefetchableIterator.html#isReady--"><code>PrefetchableIterator.isReady()</code></a>. <a href="../../../../../../org/apache/beam/sdk/fn/stream/PrefetchableIterator.html#prefetch--"><code>PrefetchableIterator.prefetch()</code></a> is also guaranteed to advance past empty iterators till it finds |
| one that is not ready.</div> |
| </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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/beam/sdk/fn/stream/PrefetchableIterator.html" title="interface in org.apache.beam.sdk.fn.stream"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/fn/stream/SynchronizedStreamObserver.html" title="class in org.apache.beam.sdk.fn.stream"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/fn/stream/PrefetchableIterators.html" target="_top">Frames</a></li> |
| <li><a href="PrefetchableIterators.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |