| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.9.1) on Fri Sep 09 19:30:40 KST 2022 --> |
| <title>DataUtil.InputStreamIterator (Nemo Project 0.4 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2022-09-09"> |
| <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="DataUtil.InputStreamIterator (Nemo Project 0.4 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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="class-use/DataUtil.InputStreamIterator.html">Use</a></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 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: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </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 id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </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> <a href="package-summary.html">org.apache.nemo.runtime.executor.data</a></div> |
| <h2 title="Class DataUtil.InputStreamIterator" class="title">Class DataUtil.InputStreamIterator<T></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.nemo.runtime.executor.data.DataUtil.InputStreamIterator<T></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - The type of elements.</dd> |
| </dl> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code>java.util.Iterator<T></code>, <code><a href="DataUtil.IteratorWithNumBytes.html" title="interface in org.apache.nemo.runtime.executor.data">DataUtil.IteratorWithNumBytes</a><T></code></dd> |
| </dl> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="DataUtil.html" title="class in org.apache.nemo.runtime.executor.data">DataUtil</a></dd> |
| </dl> |
| <hr> |
| <pre>@NotThreadSafe |
| public static final class <span class="typeNameLabel">DataUtil.InputStreamIterator<T></span> |
| extends java.lang.Object |
| implements <a href="DataUtil.IteratorWithNumBytes.html" title="interface in org.apache.nemo.runtime.executor.data">DataUtil.IteratorWithNumBytes</a><T></pre> |
| <div class="block">An iterator that emits objects from <code>InputStream</code> using the corresponding <a href="../../../common/coder/DecoderFactory.html" title="interface in org.apache.nemo.common.coder"><code>DecoderFactory</code></a>.</div> |
| </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> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.org.apache.nemo.runtime.executor.data.DataUtil.IteratorWithNumBytes"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.apache.nemo.runtime.executor.data.<a href="DataUtil.IteratorWithNumBytes.html" title="interface in org.apache.nemo.runtime.executor.data">DataUtil.IteratorWithNumBytes</a></h3> |
| <code><a href="DataUtil.IteratorWithNumBytes.NumBytesNotSupportedException.html" title="class in org.apache.nemo.runtime.executor.data">DataUtil.IteratorWithNumBytes.NumBytesNotSupportedException</a></code></li> |
| </ul> |
| </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCurrNumEncodedBytes()">getCurrNumEncodedBytes</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">This method can be called before the every actual data completely taken from iterator, |
| When the every actual data completely taken from iterator, |
| its return value must be same with a return value of getNumSerializedBytes().</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCurrNumSerializedBytes()">getCurrNumSerializedBytes</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">This method can be called before the every actual data completely taken from iterator, |
| When the every actual data completely taken from iterator, |
| its return value must be same with a return value of getNumSerializedBytes().</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNumEncodedBytes()">getNumEncodedBytes</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">This method should be called after the actual data is taken out of iterator, |
| since the existence of an iterator does not guarantee that data inside it is ready.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNumSerializedBytes()">getNumSerializedBytes</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">This method should be called after the actual data is taken out of iterator, |
| since the existence of an iterator does not guarantee that data inside it is ready.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasNext()">hasNext</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isReadNotSerializedData()">isReadNotSerializedData</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="DataUtil.InputStreamIterator.html" title="type parameter in DataUtil.InputStreamIterator">T</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#next()">next</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="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> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.util.Iterator"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface java.util.Iterator</h3> |
| <code>forEachRemaining, remove</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="hasNext()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasNext</h4> |
| <pre class="methodSignature">public boolean hasNext()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>hasNext</code> in interface <code>java.util.Iterator<<a href="DataUtil.InputStreamIterator.html" title="type parameter in DataUtil.InputStreamIterator">T</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="next()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>next</h4> |
| <pre class="methodSignature">public <a href="DataUtil.InputStreamIterator.html" title="type parameter in DataUtil.InputStreamIterator">T</a> next()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>next</code> in interface <code>java.util.Iterator<<a href="DataUtil.InputStreamIterator.html" title="type parameter in DataUtil.InputStreamIterator">T</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getNumSerializedBytes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNumSerializedBytes</h4> |
| <pre class="methodSignature">public long getNumSerializedBytes()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="DataUtil.IteratorWithNumBytes.html#getNumSerializedBytes()">DataUtil.IteratorWithNumBytes</a></code></span></div> |
| <div class="block">This method should be called after the actual data is taken out of iterator, |
| since the existence of an iterator does not guarantee that data inside it is ready.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="DataUtil.IteratorWithNumBytes.html#getNumSerializedBytes()">getNumSerializedBytes</a></code> in interface <code><a href="DataUtil.IteratorWithNumBytes.html" title="interface in org.apache.nemo.runtime.executor.data">DataUtil.IteratorWithNumBytes</a><<a href="DataUtil.InputStreamIterator.html" title="type parameter in DataUtil.InputStreamIterator">T</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of bytes in serialized form (which is, for example, encoded and compressed)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getNumEncodedBytes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNumEncodedBytes</h4> |
| <pre class="methodSignature">public long getNumEncodedBytes()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="DataUtil.IteratorWithNumBytes.html#getNumEncodedBytes()">DataUtil.IteratorWithNumBytes</a></code></span></div> |
| <div class="block">This method should be called after the actual data is taken out of iterator, |
| since the existence of an iterator does not guarantee that data inside it is ready.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="DataUtil.IteratorWithNumBytes.html#getNumEncodedBytes()">getNumEncodedBytes</a></code> in interface <code><a href="DataUtil.IteratorWithNumBytes.html" title="interface in org.apache.nemo.runtime.executor.data">DataUtil.IteratorWithNumBytes</a><<a href="DataUtil.InputStreamIterator.html" title="type parameter in DataUtil.InputStreamIterator">T</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of bytes in encoded form (which is ready to be decoded)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getCurrNumSerializedBytes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCurrNumSerializedBytes</h4> |
| <pre class="methodSignature">public long getCurrNumSerializedBytes()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="DataUtil.IteratorWithNumBytes.html#getCurrNumSerializedBytes()">DataUtil.IteratorWithNumBytes</a></code></span></div> |
| <div class="block">This method can be called before the every actual data completely taken from iterator, |
| When the every actual data completely taken from iterator, |
| its return value must be same with a return value of getNumSerializedBytes().</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="DataUtil.IteratorWithNumBytes.html#getCurrNumSerializedBytes()">getCurrNumSerializedBytes</a></code> in interface <code><a href="DataUtil.IteratorWithNumBytes.html" title="interface in org.apache.nemo.runtime.executor.data">DataUtil.IteratorWithNumBytes</a><<a href="DataUtil.InputStreamIterator.html" title="type parameter in DataUtil.InputStreamIterator">T</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of currently read bytes in serialized form (which is, for example, encoded and compressed)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getCurrNumEncodedBytes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCurrNumEncodedBytes</h4> |
| <pre class="methodSignature">public long getCurrNumEncodedBytes()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="DataUtil.IteratorWithNumBytes.html#getCurrNumEncodedBytes()">DataUtil.IteratorWithNumBytes</a></code></span></div> |
| <div class="block">This method can be called before the every actual data completely taken from iterator, |
| When the every actual data completely taken from iterator, |
| its return value must be same with a return value of getNumSerializedBytes().</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="DataUtil.IteratorWithNumBytes.html#getCurrNumEncodedBytes()">getCurrNumEncodedBytes</a></code> in interface <code><a href="DataUtil.IteratorWithNumBytes.html" title="interface in org.apache.nemo.runtime.executor.data">DataUtil.IteratorWithNumBytes</a><<a href="DataUtil.InputStreamIterator.html" title="type parameter in DataUtil.InputStreamIterator">T</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of bytes in encoded form (which is ready to be decoded)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isReadNotSerializedData()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>isReadNotSerializedData</h4> |
| <pre class="methodSignature">public boolean isReadNotSerializedData()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="DataUtil.IteratorWithNumBytes.html#isReadNotSerializedData()">isReadNotSerializedData</a></code> in interface <code><a href="DataUtil.IteratorWithNumBytes.html" title="interface in org.apache.nemo.runtime.executor.data">DataUtil.IteratorWithNumBytes</a><<a href="DataUtil.InputStreamIterator.html" title="type parameter in DataUtil.InputStreamIterator">T</a>></code></dd> |
| </dl> |
| </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="class-use/DataUtil.InputStreamIterator.html">Use</a></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 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: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
