| <!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 (version 1.7.0_07) on Tue Oct 02 13:04:16 CEST 2012 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>BufferByteArray (Apache MINA 2.0.6 API)</title> |
| <meta name="date" content="2012-10-02"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="BufferByteArray (Apache MINA 2.0.6 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/BufferByteArray.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>Prev Class</li> |
| <li><a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.html" title="interface in org.apache.mina.util.byteaccess"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/mina/util/byteaccess/BufferByteArray.html" target="_top">Frames</a></li> |
| <li><a href="BufferByteArray.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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.mina.util.byteaccess</div> |
| <h2 title="Class BufferByteArray" class="title">Class BufferByteArray</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.mina.util.byteaccess.BufferByteArray</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.html" title="interface in org.apache.mina.util.byteaccess">ByteArray</a>, <a href="../../../../../org/apache/mina/util/byteaccess/IoAbsoluteReader.html" title="interface in org.apache.mina.util.byteaccess">IoAbsoluteReader</a>, <a href="../../../../../org/apache/mina/util/byteaccess/IoAbsoluteWriter.html" title="interface in org.apache.mina.util.byteaccess">IoAbsoluteWriter</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="strong">BufferByteArray</span> |
| extends <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">A <code>ByteArray</code> backed by a <code>IoBuffer</code>. This class |
| is abstract. Subclasses need to override the <code>free()</code> method. An |
| implementation backed by a heap <code>IoBuffer</code> can be created with |
| a <code>SimpleByteArrayFactory</code>.</div> |
| <dl><dt><span class="strong">Author:</span></dt> |
| <dd><a href="http://mina.apache.org">Apache MINA Project</a></dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_class_summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_classes_inherited_from_class_org.apache.mina.util.byteaccess.ByteArray"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.apache.mina.util.byteaccess.<a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.html" title="interface in org.apache.mina.util.byteaccess">ByteArray</a></h3> |
| <code><a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.Cursor.html" title="interface in org.apache.mina.util.byteaccess">ByteArray.Cursor</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer">IoBuffer</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/BufferByteArray.html#bb">bb</a></strong></code> |
| <div class="block">The backing <code>IoBuffer</code>.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" 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><strong><a href="../../../../../org/apache/mina/util/byteaccess/BufferByteArray.html#BufferByteArray(org.apache.mina.core.buffer.IoBuffer)">BufferByteArray</a></strong>(<a href="../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer">IoBuffer</a> bb)</code> |
| <div class="block">Creates a new instance of BufferByteArray and uses the supplied |
| <a href="../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer"><code>IoBuffer</code></a> to back this class</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.Cursor.html" title="interface in org.apache.mina.util.byteaccess">ByteArray.Cursor</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/BufferByteArray.html#cursor()">cursor</a></strong>()</code> |
| <div class="block">Get a cursor starting at index 0 (which may not be the start of the array).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.Cursor.html" title="interface in org.apache.mina.util.byteaccess">ByteArray.Cursor</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/BufferByteArray.html#cursor(int)">cursor</a></strong>(int index)</code> |
| <div class="block">Get a cursor starting at the given index.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/BufferByteArray.html#equals(java.lang.Object)">equals</a></strong>(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> other)</code> |
| <div class="block">A ByteArray is equal to another ByteArray if they start and end at the |
| same index, have the same byte order, and contain the same bytes at each |
| index.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/BufferByteArray.html#first()">first</a></strong>()</code> |
| <div class="block">Get the index of the first byte that can be accessed.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/BufferByteArray.html#free()">free</a></strong>()</code> |
| <div class="block">Remove any resources associated with this object.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>byte</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/BufferByteArray.html#get(int)">get</a></strong>(int index)</code> |
| <div class="block">Gets a <code>byte</code> from the given index.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/BufferByteArray.html#get(int, org.apache.mina.core.buffer.IoBuffer)">get</a></strong>(int index, |
| <a href="../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer">IoBuffer</a> other)</code> |
| <div class="block">Gets enough bytes to fill the <code>IoBuffer</code> from the given index.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>char</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/BufferByteArray.html#getChar(int)">getChar</a></strong>(int index)</code> |
| <div class="block">Gets a <code>char</code> from the given index.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/BufferByteArray.html#getDouble(int)">getDouble</a></strong>(int index)</code> |
| <div class="block">Gets a <code>double</code> from the given index.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>float</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/BufferByteArray.html#getFloat(int)">getFloat</a></strong>(int index)</code> |
| <div class="block">Gets a <code>float</code> from the given index.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/BufferByteArray.html#getInt(int)">getInt</a></strong>(int index)</code> |
| <div class="block">Gets an <code>int</code> from the given index.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer">IoBuffer</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/BufferByteArray.html#getIoBuffers()">getIoBuffers</a></strong>()</code> |
| <div class="block">Get the sequence of <code>IoBuffer</code>s that back this array.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/BufferByteArray.html#getLong(int)">getLong</a></strong>(int index)</code> |
| <div class="block">Gets a <code>long</code> from the given index.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>short</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/BufferByteArray.html#getShort(int)">getShort</a></strong>(int index)</code> |
| <div class="block">Gets a <code>short</code> from the given index.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer">IoBuffer</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/BufferByteArray.html#getSingleIoBuffer()">getSingleIoBuffer</a></strong>()</code> |
| <div class="block">Gets a single <code>IoBuffer</code> that backs this array.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/BufferByteArray.html#last()">last</a></strong>()</code> |
| <div class="block">Gets the index after the last byte that can be accessed.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/BufferByteArray.html#length()">length</a></strong>()</code> |
| <div class="block">Gets the total number of bytes that can be accessed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteOrder.html?is-external=true" title="class or interface in java.nio">ByteOrder</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/BufferByteArray.html#order()">order</a></strong>()</code> |
| <div class="block">Gets the order of the bytes.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/BufferByteArray.html#order(java.nio.ByteOrder)">order</a></strong>(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteOrder.html?is-external=true" title="class or interface in java.nio">ByteOrder</a> order)</code> |
| <div class="block">Set the byte order of the array.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/BufferByteArray.html#put(int, byte)">put</a></strong>(int index, |
| byte b)</code> |
| <div class="block">Puts a <code>byte</code> at the given index.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/BufferByteArray.html#put(int, org.apache.mina.core.buffer.IoBuffer)">put</a></strong>(int index, |
| <a href="../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer">IoBuffer</a> other)</code> |
| <div class="block">Puts bytes from the <code>IoBuffer</code> at the given index.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/BufferByteArray.html#putChar(int, char)">putChar</a></strong>(int index, |
| char c)</code> |
| <div class="block">Puts a <code>char</code> at the given index.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/BufferByteArray.html#putDouble(int, double)">putDouble</a></strong>(int index, |
| double d)</code> |
| <div class="block">Puts a <code>double</code> at the given index.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/BufferByteArray.html#putFloat(int, float)">putFloat</a></strong>(int index, |
| float f)</code> |
| <div class="block">Puts a <code>float</code> at the given index.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/BufferByteArray.html#putInt(int, int)">putInt</a></strong>(int index, |
| int i)</code> |
| <div class="block">Puts an <code>int</code> at the given index.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/BufferByteArray.html#putLong(int, long)">putLong</a></strong>(int index, |
| long l)</code> |
| <div class="block">Puts a <code>long</code> at the given index.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/BufferByteArray.html#putShort(int, short)">putShort</a></strong>(int index, |
| short s)</code> |
| <div class="block">Puts a <code>short</code> at the given index.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.html" title="interface in org.apache.mina.util.byteaccess">ByteArray</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/util/byteaccess/BufferByteArray.html#slice(int, int)">slice</a></strong>(int index, |
| int length)</code> |
| <div class="block">Creates an array with a view of part of this array.</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.<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="bb"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>bb</h4> |
| <pre>protected <a href="../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer">IoBuffer</a> bb</pre> |
| <div class="block">The backing <code>IoBuffer</code>.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="BufferByteArray(org.apache.mina.core.buffer.IoBuffer)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>BufferByteArray</h4> |
| <pre>public BufferByteArray(<a href="../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer">IoBuffer</a> bb)</pre> |
| <div class="block">Creates a new instance of BufferByteArray and uses the supplied |
| <a href="../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer"><code>IoBuffer</code></a> to back this class</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>bb</code> - The backing buffer</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getIoBuffers()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIoBuffers</h4> |
| <pre>public <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer">IoBuffer</a>> getIoBuffers()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.html#getIoBuffers()">ByteArray</a></code></strong></div> |
| <div class="block">Get the sequence of <code>IoBuffer</code>s that back this array. |
| Compared to <code>getSingleIoBuffer()</code>, this method should be |
| relatively efficient for all implementations.</div> |
| </li> |
| </ul> |
| <a name="getSingleIoBuffer()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSingleIoBuffer</h4> |
| <pre>public <a href="../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer">IoBuffer</a> getSingleIoBuffer()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.html#getSingleIoBuffer()">ByteArray</a></code></strong></div> |
| <div class="block">Gets a single <code>IoBuffer</code> that backs this array. Some |
| implementations may initially have data split across multiple buffers, so |
| calling this method may require a new buffer to be allocated and |
| populated.</div> |
| </li> |
| </ul> |
| <a name="slice(int, int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>slice</h4> |
| <pre>public <a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.html" title="interface in org.apache.mina.util.byteaccess">ByteArray</a> slice(int index, |
| int length)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/IoAbsoluteReader.html#slice(int, int)">IoAbsoluteReader</a></code></strong></div> |
| <div class="block">Creates an array with a view of part of this array.</div> |
| </li> |
| </ul> |
| <a name="free()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>free</h4> |
| <pre>public abstract void free()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.html#free()">ByteArray</a></code></strong></div> |
| <div class="block">Remove any resources associated with this object. Using the object after |
| this method is called may result in undefined behaviour.</div> |
| </li> |
| </ul> |
| <a name="cursor()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cursor</h4> |
| <pre>public <a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.Cursor.html" title="interface in org.apache.mina.util.byteaccess">ByteArray.Cursor</a> cursor()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.html#cursor()">ByteArray</a></code></strong></div> |
| <div class="block">Get a cursor starting at index 0 (which may not be the start of the array).</div> |
| </li> |
| </ul> |
| <a name="cursor(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cursor</h4> |
| <pre>public <a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.Cursor.html" title="interface in org.apache.mina.util.byteaccess">ByteArray.Cursor</a> cursor(int index)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.html#cursor(int)">ByteArray</a></code></strong></div> |
| <div class="block">Get a cursor starting at the given index.</div> |
| </li> |
| </ul> |
| <a name="first()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>first</h4> |
| <pre>public int first()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/IoAbsoluteReader.html#first()">IoAbsoluteReader</a></code></strong></div> |
| <div class="block">Get the index of the first byte that can be accessed.</div> |
| </li> |
| </ul> |
| <a name="last()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>last</h4> |
| <pre>public int last()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/IoAbsoluteReader.html#last()">IoAbsoluteReader</a></code></strong></div> |
| <div class="block">Gets the index after the last byte that can be accessed.</div> |
| </li> |
| </ul> |
| <a name="order()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>order</h4> |
| <pre>public <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteOrder.html?is-external=true" title="class or interface in java.nio">ByteOrder</a> order()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/IoAbsoluteReader.html#order()">IoAbsoluteReader</a></code></strong></div> |
| <div class="block">Gets the order of the bytes.</div> |
| </li> |
| </ul> |
| <a name="order(java.nio.ByteOrder)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>order</h4> |
| <pre>public void order(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteOrder.html?is-external=true" title="class or interface in java.nio">ByteOrder</a> order)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.html#order(java.nio.ByteOrder)">ByteArray</a></code></strong></div> |
| <div class="block">Set the byte order of the array.</div> |
| </li> |
| </ul> |
| <a name="get(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre>public byte get(int index)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/IoAbsoluteReader.html#get(int)">IoAbsoluteReader</a></code></strong></div> |
| <div class="block">Gets a <code>byte</code> from the given index.</div> |
| </li> |
| </ul> |
| <a name="put(int, byte)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>put</h4> |
| <pre>public void put(int index, |
| byte b)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/IoAbsoluteWriter.html#put(int, byte)">IoAbsoluteWriter</a></code></strong></div> |
| <div class="block">Puts a <code>byte</code> at the given index.</div> |
| </li> |
| </ul> |
| <a name="get(int, org.apache.mina.core.buffer.IoBuffer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre>public void get(int index, |
| <a href="../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer">IoBuffer</a> other)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/IoAbsoluteReader.html#get(int, org.apache.mina.core.buffer.IoBuffer)">IoAbsoluteReader</a></code></strong></div> |
| <div class="block">Gets enough bytes to fill the <code>IoBuffer</code> from the given index.</div> |
| </li> |
| </ul> |
| <a name="put(int, org.apache.mina.core.buffer.IoBuffer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>put</h4> |
| <pre>public void put(int index, |
| <a href="../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer">IoBuffer</a> other)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/IoAbsoluteWriter.html#put(int, org.apache.mina.core.buffer.IoBuffer)">IoAbsoluteWriter</a></code></strong></div> |
| <div class="block">Puts bytes from the <code>IoBuffer</code> at the given index.</div> |
| </li> |
| </ul> |
| <a name="getShort(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getShort</h4> |
| <pre>public short getShort(int index)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/IoAbsoluteReader.html#getShort(int)">IoAbsoluteReader</a></code></strong></div> |
| <div class="block">Gets a <code>short</code> from the given index.</div> |
| </li> |
| </ul> |
| <a name="putShort(int, short)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putShort</h4> |
| <pre>public void putShort(int index, |
| short s)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/IoAbsoluteWriter.html#putShort(int, short)">IoAbsoluteWriter</a></code></strong></div> |
| <div class="block">Puts a <code>short</code> at the given index.</div> |
| </li> |
| </ul> |
| <a name="getInt(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInt</h4> |
| <pre>public int getInt(int index)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/IoAbsoluteReader.html#getInt(int)">IoAbsoluteReader</a></code></strong></div> |
| <div class="block">Gets an <code>int</code> from the given index.</div> |
| </li> |
| </ul> |
| <a name="putInt(int, int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putInt</h4> |
| <pre>public void putInt(int index, |
| int i)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/IoAbsoluteWriter.html#putInt(int, int)">IoAbsoluteWriter</a></code></strong></div> |
| <div class="block">Puts an <code>int</code> at the given index.</div> |
| </li> |
| </ul> |
| <a name="getLong(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLong</h4> |
| <pre>public long getLong(int index)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/IoAbsoluteReader.html#getLong(int)">IoAbsoluteReader</a></code></strong></div> |
| <div class="block">Gets a <code>long</code> from the given index.</div> |
| </li> |
| </ul> |
| <a name="putLong(int, long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putLong</h4> |
| <pre>public void putLong(int index, |
| long l)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/IoAbsoluteWriter.html#putLong(int, long)">IoAbsoluteWriter</a></code></strong></div> |
| <div class="block">Puts a <code>long</code> at the given index.</div> |
| </li> |
| </ul> |
| <a name="getFloat(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFloat</h4> |
| <pre>public float getFloat(int index)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/IoAbsoluteReader.html#getFloat(int)">IoAbsoluteReader</a></code></strong></div> |
| <div class="block">Gets a <code>float</code> from the given index.</div> |
| </li> |
| </ul> |
| <a name="putFloat(int, float)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putFloat</h4> |
| <pre>public void putFloat(int index, |
| float f)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/IoAbsoluteWriter.html#putFloat(int, float)">IoAbsoluteWriter</a></code></strong></div> |
| <div class="block">Puts a <code>float</code> at the given index.</div> |
| </li> |
| </ul> |
| <a name="getDouble(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDouble</h4> |
| <pre>public double getDouble(int index)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/IoAbsoluteReader.html#getDouble(int)">IoAbsoluteReader</a></code></strong></div> |
| <div class="block">Gets a <code>double</code> from the given index.</div> |
| </li> |
| </ul> |
| <a name="putDouble(int, double)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putDouble</h4> |
| <pre>public void putDouble(int index, |
| double d)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/IoAbsoluteWriter.html#putDouble(int, double)">IoAbsoluteWriter</a></code></strong></div> |
| <div class="block">Puts a <code>double</code> at the given index.</div> |
| </li> |
| </ul> |
| <a name="getChar(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getChar</h4> |
| <pre>public char getChar(int index)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/IoAbsoluteReader.html#getChar(int)">IoAbsoluteReader</a></code></strong></div> |
| <div class="block">Gets a <code>char</code> from the given index.</div> |
| </li> |
| </ul> |
| <a name="putChar(int, char)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putChar</h4> |
| <pre>public void putChar(int index, |
| char c)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/IoAbsoluteWriter.html#putChar(int, char)">IoAbsoluteWriter</a></code></strong></div> |
| <div class="block">Puts a <code>char</code> at the given index.</div> |
| </li> |
| </ul> |
| <a name="length()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>length</h4> |
| <pre>public final int length()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/IoAbsoluteReader.html#length()">IoAbsoluteReader</a></code></strong></div> |
| <div class="block">Gets the total number of bytes that can be accessed.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/mina/util/byteaccess/IoAbsoluteReader.html#length()">length</a></code> in interface <code><a href="../../../../../org/apache/mina/util/byteaccess/IoAbsoluteReader.html" title="interface in org.apache.mina.util.byteaccess">IoAbsoluteReader</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="equals(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre>public final boolean equals(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> other)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.html#equals(java.lang.Object)">ByteArray</a></code></strong></div> |
| <div class="block">A ByteArray is equal to another ByteArray if they start and end at the |
| same index, have the same byte order, and contain the same bytes at each |
| index.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.html#equals(java.lang.Object)">equals</a></code> in interface <code><a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.html" title="interface in org.apache.mina.util.byteaccess">ByteArray</a></code></dd> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a></code> in class <code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/BufferByteArray.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>Prev Class</li> |
| <li><a href="../../../../../org/apache/mina/util/byteaccess/ByteArray.html" title="interface in org.apache.mina.util.byteaccess"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/mina/util/byteaccess/BufferByteArray.html" target="_top">Frames</a></li> |
| <li><a href="BufferByteArray.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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 ======= --> |
| <p class="legalCopy"><small>Copyright © 2004-2012 <a href="http://mina.apache.org/">Apache MINA Project</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |
