| <!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 (1.8.0_191) on Fri Apr 12 11:24:36 CEST 2019 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>ByteArray.Cursor (Apache MINA 2.0.21 API Documentation)</title> |
| <meta name="date" content="2019-04-12"> |
| <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="ByteArray.Cursor (Apache MINA 2.0.21 API Documentation)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":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="class-use/ByteArray.Cursor.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"> |
| <li><a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.html" title="interface in org.apache.mina.util.byteaccess"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/mina/util/byteaccess/ByteArrayFactory.html" title="interface in org.apache.mina.util.byteaccess"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/mina/util/byteaccess/ByteArray.Cursor.html" target="_top">Frames</a></li> |
| <li><a href="ByteArray.Cursor.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.mina.util.byteaccess</div> |
| <h2 title="Interface ByteArray.Cursor" class="title">Interface ByteArray.Cursor</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeReader.html" title="interface in org.apache.mina.util.byteaccess">IoRelativeReader</a>, <a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html" title="interface in org.apache.mina.util.byteaccess">IoRelativeWriter</a></dd> |
| </dl> |
| <dl> |
| <dt>Enclosing interface:</dt> |
| <dd><a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.html" title="interface in org.apache.mina.util.byteaccess">ByteArray</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static interface <span class="typeNameLabel">ByteArray.Cursor</span> |
| extends <a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeReader.html" title="interface in org.apache.mina.util.byteaccess">IoRelativeReader</a>, <a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html" title="interface in org.apache.mina.util.byteaccess">IoRelativeWriter</a></pre> |
| <div class="block">Provides relocatable, relative access to the underlying array. Multiple |
| cursors may be used simultaneously, and cursors will stay consistent with |
| the underlying array, even across modifications. |
| |
| Should this be <code>Cloneable</code> to allow cheap mark/position |
| emulation?</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>byte</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.Cursor.html#get--">get</a></span>()</code></td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.Cursor.html#get-org.apache.mina.core.buffer.IoBuffer-">get</a></span>(<a href="../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer">IoBuffer</a> bb)</code> |
| <div class="block">Gets enough bytes to fill the <code>IoBuffer</code> and advances the reader.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.Cursor.html#getIndex--">getIndex</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.Cursor.html#getInt--">getInt</a></span>()</code></td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.Cursor.html#getRemaining--">getRemaining</a></span>()</code></td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.Cursor.html#hasRemaining--">hasRemaining</a></span>()</code> |
| <div class="block">Checks if there are any remaining bytes that can be read.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.Cursor.html#setIndex-int-">setIndex</a></span>(int index)</code> |
| <div class="block">Sets the current index of the cursor.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.mina.util.byteaccess.IoRelativeReader"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.mina.util.byteaccess.<a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeReader.html" title="interface in org.apache.mina.util.byteaccess">IoRelativeReader</a></h3> |
| <code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeReader.html#getChar--">getChar</a>, <a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeReader.html#getDouble--">getDouble</a>, <a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeReader.html#getFloat--">getFloat</a>, <a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeReader.html#getLong--">getLong</a>, <a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeReader.html#getShort--">getShort</a>, <a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeReader.html#order--">order</a>, <a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeReader.html#skip-int-">skip</a>, <a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeReader.html#slice-int-">slice</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.mina.util.byteaccess.IoRelativeWriter"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.mina.util.byteaccess.<a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html" title="interface in org.apache.mina.util.byteaccess">IoRelativeWriter</a></h3> |
| <code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#order--">order</a>, <a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#put-byte-">put</a>, <a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#put-org.apache.mina.core.buffer.IoBuffer-">put</a>, <a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#putChar-char-">putChar</a>, <a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#putDouble-double-">putDouble</a>, <a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#putFloat-float-">putFloat</a>, <a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#putInt-int-">putInt</a>, <a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#putLong-long-">putLong</a>, <a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#putShort-short-">putShort</a>, <a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#skip-int-">skip</a></code></li> |
| </ul> |
| </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="getIndex--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIndex</h4> |
| <pre>int getIndex()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current index of the cursor.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setIndex-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIndex</h4> |
| <pre>void setIndex(int index)</pre> |
| <div class="block">Sets the current index of the cursor. No bounds checking will occur |
| until an access occurs.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - The current index to set</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRemaining--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRemaining</h4> |
| <pre>int getRemaining()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeReader.html#getRemaining--">getRemaining</a></code> in interface <code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeReader.html" title="interface in org.apache.mina.util.byteaccess">IoRelativeReader</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#getRemaining--">getRemaining</a></code> in interface <code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html" title="interface in org.apache.mina.util.byteaccess">IoRelativeWriter</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of remaining bytes that can be read.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasRemaining--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasRemaining</h4> |
| <pre>boolean hasRemaining()</pre> |
| <div class="block">Checks if there are any remaining bytes that can be read.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeReader.html#hasRemaining--">hasRemaining</a></code> in interface <code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeReader.html" title="interface in org.apache.mina.util.byteaccess">IoRelativeReader</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html#hasRemaining--">hasRemaining</a></code> in interface <code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeWriter.html" title="interface in org.apache.mina.util.byteaccess">IoRelativeWriter</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><tt>true</tt> if there are some remaining bytes in the buffer</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="get--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre>byte get()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeReader.html#get--">get</a></code> in interface <code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeReader.html" title="interface in org.apache.mina.util.byteaccess">IoRelativeReader</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>byte</code> at the current position and advances the reader.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="get-org.apache.mina.core.buffer.IoBuffer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre>void get(<a href="../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer">IoBuffer</a> bb)</pre> |
| <div class="block">Gets enough bytes to fill the <code>IoBuffer</code> and advances the reader.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeReader.html#get-org.apache.mina.core.buffer.IoBuffer-">get</a></code> in interface <code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeReader.html" title="interface in org.apache.mina.util.byteaccess">IoRelativeReader</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>bb</code> - The IoBuffer that will contain the read bytes</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInt--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getInt</h4> |
| <pre>int getInt()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeReader.html#getInt--">getInt</a></code> in interface <code><a href="../../../../../org/apache/mina/util/byteaccess/IoRelativeReader.html" title="interface in org.apache.mina.util.byteaccess">IoRelativeReader</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an <code>int</code> and advances the reader.</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="class-use/ByteArray.Cursor.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"> |
| <li><a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.html" title="interface in org.apache.mina.util.byteaccess"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/mina/util/byteaccess/ByteArrayFactory.html" title="interface in org.apache.mina.util.byteaccess"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/mina/util/byteaccess/ByteArray.Cursor.html" target="_top">Frames</a></li> |
| <li><a href="ByteArray.Cursor.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 © 2004–2019 <a href="http://mina.apache.org/">Apache MINA Project</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
