| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>CompositeReadableBuffer (Qpid Proton-J API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
| <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="CompositeReadableBuffer (Qpid Proton-J API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":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"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../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> |
| <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><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 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.qpid.proton.codec</a></div> |
| <h2 title="Class CompositeReadableBuffer" class="title">Class CompositeReadableBuffer</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.qpid.proton.codec.CompositeReadableBuffer</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">CompositeReadableBuffer</span> |
| extends java.lang.Object |
| implements <a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></pre> |
| <div class="block">ReadableBuffer implementation whose content is made up of one or more |
| byte arrays.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <section> |
| <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.qpid.proton.codec.ReadableBuffer"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.apache.qpid.proton.codec.<a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></h3> |
| <code><a href="ReadableBuffer.ByteBufferReader.html" title="class in org.apache.qpid.proton.codec">ReadableBuffer.ByteBufferReader</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">CompositeReadableBuffer</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a default empty composite buffer</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section> |
| <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><a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec">CompositeReadableBuffer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#append(byte%5B%5D)">append</a></span>​(byte[] array)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds the given array into the composite buffer at the end.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec">CompositeReadableBuffer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#append(org.apache.qpid.proton.codec.CompositeReadableBuffer)">append</a></span>​(<a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec">CompositeReadableBuffer</a> buffer)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds the given composite buffer contents (from current position, up to the limit) into this |
| composite buffer at the end.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec">CompositeReadableBuffer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#append(org.apache.qpid.proton.codec.ReadableBuffer)">append</a></span>​(<a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a> buffer)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds the given readable buffer contents (from current position, up to the limit) into this |
| composite buffer at the end.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#array()">array</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the primitive array that backs this buffer if one exists and the |
| buffer is not read-only.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#arrayOffset()">arrayOffset</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the offset into the backing array of the first element in the buffer.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.nio.ByteBuffer</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#byteBuffer()">byteBuffer</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#capacity()">capacity</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the capacity of the backing buffer of this ReadableBuffer</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec">CompositeReadableBuffer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clear()">clear</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Resets the buffer position to zero and sets the limit to the buffer capacity, |
| the mark value is discarded if set.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec">CompositeReadableBuffer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#duplicate()">duplicate</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a duplicate <a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec"><code>ReadableBuffer</code></a> to this instance.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>​(java.lang.Object other)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec">CompositeReadableBuffer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#flip()">flip</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the buffer limit to the current position and the position is set to zero, the |
| mark value reset to undefined.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>byte</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#get()">get</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Reads the byte at the current position and advances the position by 1.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec">CompositeReadableBuffer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#get(byte%5B%5D)">get</a></span>​(byte[] data)</code></th> |
| <td class="colLast"> |
| <div class="block">A bulk read method that copies bytes from this buffer into the target byte array.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec">CompositeReadableBuffer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#get(byte%5B%5D,int,int)">get</a></span>​(byte[] data, |
| int offset, |
| int length)</code></th> |
| <td class="colLast"> |
| <div class="block">A bulk read method that copies bytes from this buffer into the target byte array.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>byte</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#get(int)">get</a></span>​(int index)</code></th> |
| <td class="colLast"> |
| <div class="block">Reads the byte at the given index, the buffer position is not affected.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec">CompositeReadableBuffer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#get(org.apache.qpid.proton.codec.WritableBuffer)">get</a></span>​(<a href="WritableBuffer.html" title="interface in org.apache.qpid.proton.codec">WritableBuffer</a> target)</code></th> |
| <td class="colLast"> |
| <div class="block">Copy data from this buffer to the target buffer starting from the current |
| position and continuing until either this buffer's remaining bytes are |
| consumed or the target is full.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>java.util.List<byte[]></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getArrays()">getArrays</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCurrentArrayPosition()">getCurrentArrayPosition</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the current position index in the current backing array, which represents the current buffer position.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCurrentIndex()">getCurrentIndex</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>double</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDouble()">getDouble</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Reads eight bytes from the buffer and returns them as an double value.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>float</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFloat()">getFloat</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Reads four bytes from the buffer and returns them as an float value.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInt()">getInt</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Reads four bytes from the buffer and returns them as an integer value.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLong()">getLong</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Reads eight bytes from the buffer and returns them as an long value.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>short</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getShort()">getShort</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Reads two bytes from the buffer and returns them as an short value.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasArray()">hasArray</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns true if this ReadableBuffer is backed by an array which can be |
| accessed by the <a href="ReadableBuffer.html#array()"><code>ReadableBuffer.array()</code></a> and <a href="ReadableBuffer.html#arrayOffset()"><code>ReadableBuffer.arrayOffset()</code></a> methods.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasRemaining()">hasRemaining</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#limit()">limit</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code><a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec">CompositeReadableBuffer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#limit(int)">limit</a></span>​(int limit)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the current read limit of this buffer to the given value.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code><a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec">CompositeReadableBuffer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#mark()">mark</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Mark the current position of this buffer which can be returned to after a |
| read operation by calling <a href="ReadableBuffer.html#reset()"><code>ReadableBuffer.reset()</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#position()">position</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code><a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec">CompositeReadableBuffer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#position(int)">position</a></span>​(int position)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the current position of this buffer to the given value.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readString(java.nio.charset.CharsetDecoder)">readString</a></span>​(java.nio.charset.CharsetDecoder decoder)</code></th> |
| <td class="colLast"> |
| <div class="block">Decodes a String from the buffer using the provided <code>CharsetDecoder</code> |
| starting the decode at the current position and reading until the limit is |
| reached.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readUTF8()">readUTF8</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Reads a UTF-8 encoded String from the buffer starting the decode at the |
| current position and reading until the limit is reached.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code><a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec">CompositeReadableBuffer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reclaimRead()">reclaimRead</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Compact the buffer dropping arrays that have been consumed by previous |
| reads from this Composite buffer.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#remaining()">remaining</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code><a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec">CompositeReadableBuffer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reset()">reset</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Reset the buffer's position to a previously marked value, the mark should remain |
| set after calling this method.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code><a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec">CompositeReadableBuffer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rewind()">rewind</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Resets the buffer position to zero and clears and previously set mark.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code><a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec">CompositeReadableBuffer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#slice()">slice</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new ReadableBuffer instance that is a view of the readable portion of |
| this buffer.</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</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, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>CompositeReadableBuffer</h4> |
| <pre>public CompositeReadableBuffer()</pre> |
| <div class="block">Creates a default empty composite buffer</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getArrays()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getArrays</h4> |
| <pre class="methodSignature">public java.util.List<byte[]> getArrays()</pre> |
| </li> |
| </ul> |
| <a id="getCurrentIndex()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCurrentIndex</h4> |
| <pre class="methodSignature">public int getCurrentIndex()</pre> |
| </li> |
| </ul> |
| <a id="getCurrentArrayPosition()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCurrentArrayPosition</h4> |
| <pre class="methodSignature">public int getCurrentArrayPosition()</pre> |
| <div class="block">Gets the current position index in the current backing array, which represents the current buffer position. |
| |
| This value includes any buffer position movement, and resets when moving across array segments, so it only |
| gives the starting offset for the first array if the buffer position is 0. |
| |
| Value may be out of array bounds if the the buffer currently has no content remaining.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the position index in the current array representing the current buffer position.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="hasArray()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasArray</h4> |
| <pre class="methodSignature">public boolean hasArray()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ReadableBuffer.html#hasArray()">ReadableBuffer</a></code></span></div> |
| <div class="block">Returns true if this ReadableBuffer is backed by an array which can be |
| accessed by the <a href="ReadableBuffer.html#array()"><code>ReadableBuffer.array()</code></a> and <a href="ReadableBuffer.html#arrayOffset()"><code>ReadableBuffer.arrayOffset()</code></a> methods.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ReadableBuffer.html#hasArray()">hasArray</a></code> in interface <code><a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the buffer is backed by a primitive array.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="capacity()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>capacity</h4> |
| <pre class="methodSignature">public int capacity()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ReadableBuffer.html#capacity()">ReadableBuffer</a></code></span></div> |
| <div class="block">Returns the capacity of the backing buffer of this ReadableBuffer</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ReadableBuffer.html#capacity()">capacity</a></code> in interface <code><a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the capacity of the backing buffer of this ReadableBuffer</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="array()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>array</h4> |
| <pre class="methodSignature">public byte[] array()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ReadableBuffer.html#array()">ReadableBuffer</a></code></span></div> |
| <div class="block">Returns the primitive array that backs this buffer if one exists and the |
| buffer is not read-only. The caller should have checked the <a href="ReadableBuffer.html#hasArray()"><code>ReadableBuffer.hasArray()</code></a> |
| method before calling this method.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ReadableBuffer.html#array()">array</a></code> in interface <code><a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the array that backs this buffer is available.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="arrayOffset()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>arrayOffset</h4> |
| <pre class="methodSignature">public int arrayOffset()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ReadableBuffer.html#arrayOffset()">ReadableBuffer</a></code></span></div> |
| <div class="block">Returns the offset into the backing array of the first element in the buffer. The caller |
| should have checked the <a href="ReadableBuffer.html#hasArray()"><code>ReadableBuffer.hasArray()</code></a> method before calling this method.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ReadableBuffer.html#arrayOffset()">arrayOffset</a></code> in interface <code><a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the offset into the backing array of the first element in the buffer.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="get()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre class="methodSignature">public byte get()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ReadableBuffer.html#get()">ReadableBuffer</a></code></span></div> |
| <div class="block">Reads the byte at the current position and advances the position by 1.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ReadableBuffer.html#get()">get</a></code> in interface <code><a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the byte at the current position.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="get(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre class="methodSignature">public byte get​(int index)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ReadableBuffer.html#get(int)">ReadableBuffer</a></code></span></div> |
| <div class="block">Reads the byte at the given index, the buffer position is not affected.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ReadableBuffer.html#get(int)">get</a></code> in interface <code><a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - The index in the buffer from which to read the byte.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the byte value stored at the target index.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getInt()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInt</h4> |
| <pre class="methodSignature">public int getInt()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ReadableBuffer.html#getInt()">ReadableBuffer</a></code></span></div> |
| <div class="block">Reads four bytes from the buffer and returns them as an integer value. The |
| buffer position is advanced by four byes.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ReadableBuffer.html#getInt()">getInt</a></code> in interface <code><a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>and integer value composed of bytes read from the buffer.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getLong()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLong</h4> |
| <pre class="methodSignature">public long getLong()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ReadableBuffer.html#getLong()">ReadableBuffer</a></code></span></div> |
| <div class="block">Reads eight bytes from the buffer and returns them as an long value. The |
| buffer position is advanced by eight byes.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ReadableBuffer.html#getLong()">getLong</a></code> in interface <code><a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>and long value composed of bytes read from the buffer.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getShort()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getShort</h4> |
| <pre class="methodSignature">public short getShort()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ReadableBuffer.html#getShort()">ReadableBuffer</a></code></span></div> |
| <div class="block">Reads two bytes from the buffer and returns them as an short value. The |
| buffer position is advanced by two byes.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ReadableBuffer.html#getShort()">getShort</a></code> in interface <code><a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>and short value composed of bytes read from the buffer.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getFloat()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFloat</h4> |
| <pre class="methodSignature">public float getFloat()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ReadableBuffer.html#getFloat()">ReadableBuffer</a></code></span></div> |
| <div class="block">Reads four bytes from the buffer and returns them as an float value. The |
| buffer position is advanced by four byes.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ReadableBuffer.html#getFloat()">getFloat</a></code> in interface <code><a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>and float value composed of bytes read from the buffer.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDouble()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDouble</h4> |
| <pre class="methodSignature">public double getDouble()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ReadableBuffer.html#getDouble()">ReadableBuffer</a></code></span></div> |
| <div class="block">Reads eight bytes from the buffer and returns them as an double value. The |
| buffer position is advanced by eight byes.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ReadableBuffer.html#getDouble()">getDouble</a></code> in interface <code><a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>and double value composed of bytes read from the buffer.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="get(byte[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre class="methodSignature">public <a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec">CompositeReadableBuffer</a> get​(byte[] data)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ReadableBuffer.html#get(byte%5B%5D)">ReadableBuffer</a></code></span></div> |
| <div class="block">A bulk read method that copies bytes from this buffer into the target byte array.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ReadableBuffer.html#get(byte%5B%5D)">get</a></code> in interface <code><a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>data</code> - The byte array to copy bytes read from this buffer.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this ReadableBuffer instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="get(byte[],int,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre class="methodSignature">public <a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec">CompositeReadableBuffer</a> get​(byte[] data, |
| int offset, |
| int length)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ReadableBuffer.html#get(byte%5B%5D,int,int)">ReadableBuffer</a></code></span></div> |
| <div class="block">A bulk read method that copies bytes from this buffer into the target byte array.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ReadableBuffer.html#get(byte%5B%5D,int,int)">get</a></code> in interface <code><a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>data</code> - The byte array to copy bytes read from this buffer.</dd> |
| <dd><code>offset</code> - The offset into the given array where the copy starts.</dd> |
| <dd><code>length</code> - The number of bytes to copy into the target array.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this ReadableBuffer instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="get(org.apache.qpid.proton.codec.WritableBuffer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre class="methodSignature">public <a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec">CompositeReadableBuffer</a> get​(<a href="WritableBuffer.html" title="interface in org.apache.qpid.proton.codec">WritableBuffer</a> target)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ReadableBuffer.html#get(org.apache.qpid.proton.codec.WritableBuffer)">ReadableBuffer</a></code></span></div> |
| <div class="block">Copy data from this buffer to the target buffer starting from the current |
| position and continuing until either this buffer's remaining bytes are |
| consumed or the target is full.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ReadableBuffer.html#get(org.apache.qpid.proton.codec.WritableBuffer)">get</a></code> in interface <code><a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>target</code> - The WritableBuffer to transfer this buffer's data to.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this ReadableBuffer instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="position(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>position</h4> |
| <pre class="methodSignature">public <a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec">CompositeReadableBuffer</a> position​(int position)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ReadableBuffer.html#position(int)">ReadableBuffer</a></code></span></div> |
| <div class="block">Sets the current position of this buffer to the given value. If the buffer mark |
| value is defined and is larger than the newly set position is must be discarded.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ReadableBuffer.html#position(int)">position</a></code> in interface <code><a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>position</code> - The new position to set for this buffer.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this <a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec"><code>ReadableBuffer</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="position()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>position</h4> |
| <pre class="methodSignature">public int position()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ReadableBuffer.html#position()">position</a></code> in interface <code><a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current position from which the next read operation will start.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="slice()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>slice</h4> |
| <pre class="methodSignature">public <a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec">CompositeReadableBuffer</a> slice()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ReadableBuffer.html#slice()">ReadableBuffer</a></code></span></div> |
| <div class="block">Creates a new ReadableBuffer instance that is a view of the readable portion of |
| this buffer. The position will be set to zero and the limit and the reported capacity |
| will match the value returned by this buffer's <a href="ReadableBuffer.html#remaining()"><code>ReadableBuffer.remaining()</code></a> method, the mark |
| will be undefined.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ReadableBuffer.html#slice()">slice</a></code> in interface <code><a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new ReadableBuffer that is a view of the readable portion of this buffer.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="flip()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>flip</h4> |
| <pre class="methodSignature">public <a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec">CompositeReadableBuffer</a> flip()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ReadableBuffer.html#flip()">ReadableBuffer</a></code></span></div> |
| <div class="block">Sets the buffer limit to the current position and the position is set to zero, the |
| mark value reset to undefined.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ReadableBuffer.html#flip()">flip</a></code> in interface <code><a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this <a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec"><code>ReadableBuffer</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="limit(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>limit</h4> |
| <pre class="methodSignature">public <a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec">CompositeReadableBuffer</a> limit​(int limit)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ReadableBuffer.html#limit(int)">ReadableBuffer</a></code></span></div> |
| <div class="block">Sets the current read limit of this buffer to the given value. If the buffer mark |
| value is defined and is larger than the limit the mark will be discarded. If the |
| position is larger than the new limit it will be reset to the new limit.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ReadableBuffer.html#limit(int)">limit</a></code> in interface <code><a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>limit</code> - The new read limit to set for this buffer.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this <a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec"><code>ReadableBuffer</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="limit()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>limit</h4> |
| <pre class="methodSignature">public int limit()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ReadableBuffer.html#limit()">limit</a></code> in interface <code><a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current value of this buffer's limit.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="mark()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>mark</h4> |
| <pre class="methodSignature">public <a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec">CompositeReadableBuffer</a> mark()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ReadableBuffer.html#mark()">ReadableBuffer</a></code></span></div> |
| <div class="block">Mark the current position of this buffer which can be returned to after a |
| read operation by calling <a href="ReadableBuffer.html#reset()"><code>ReadableBuffer.reset()</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ReadableBuffer.html#mark()">mark</a></code> in interface <code><a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this <a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec"><code>ReadableBuffer</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="reset()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reset</h4> |
| <pre class="methodSignature">public <a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec">CompositeReadableBuffer</a> reset()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ReadableBuffer.html#reset()">ReadableBuffer</a></code></span></div> |
| <div class="block">Reset the buffer's position to a previously marked value, the mark should remain |
| set after calling this method.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ReadableBuffer.html#reset()">reset</a></code> in interface <code><a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this <a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec"><code>ReadableBuffer</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="rewind()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rewind</h4> |
| <pre class="methodSignature">public <a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec">CompositeReadableBuffer</a> rewind()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ReadableBuffer.html#rewind()">ReadableBuffer</a></code></span></div> |
| <div class="block">Resets the buffer position to zero and clears and previously set mark.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ReadableBuffer.html#rewind()">rewind</a></code> in interface <code><a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this <a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec"><code>ReadableBuffer</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="clear()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clear</h4> |
| <pre class="methodSignature">public <a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec">CompositeReadableBuffer</a> clear()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ReadableBuffer.html#clear()">ReadableBuffer</a></code></span></div> |
| <div class="block">Resets the buffer position to zero and sets the limit to the buffer capacity, |
| the mark value is discarded if set.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ReadableBuffer.html#clear()">clear</a></code> in interface <code><a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this <a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec"><code>ReadableBuffer</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="remaining()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>remaining</h4> |
| <pre class="methodSignature">public int remaining()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ReadableBuffer.html#remaining()">remaining</a></code> in interface <code><a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the remaining number of readable bytes in this buffer.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="hasRemaining()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasRemaining</h4> |
| <pre class="methodSignature">public boolean hasRemaining()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ReadableBuffer.html#hasRemaining()">hasRemaining</a></code> in interface <code><a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if there are readable bytes still remaining in this buffer.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="duplicate()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>duplicate</h4> |
| <pre class="methodSignature">public <a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec">CompositeReadableBuffer</a> duplicate()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ReadableBuffer.html#duplicate()">ReadableBuffer</a></code></span></div> |
| <div class="block">Creates a duplicate <a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec"><code>ReadableBuffer</code></a> to this instance. |
| <p> |
| The duplicated buffer will have the same position, limit and mark as this |
| buffer. The two buffers share the same backing data.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ReadableBuffer.html#duplicate()">duplicate</a></code> in interface <code><a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a duplicate of this <a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec"><code>ReadableBuffer</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="byteBuffer()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>byteBuffer</h4> |
| <pre class="methodSignature">public java.nio.ByteBuffer byteBuffer()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ReadableBuffer.html#byteBuffer()">byteBuffer</a></code> in interface <code><a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a ByteBuffer view of the current readable portion of this buffer.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="readUTF8()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readUTF8</h4> |
| <pre class="methodSignature">public java.lang.String readUTF8() |
| throws java.nio.charset.CharacterCodingException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ReadableBuffer.html#readUTF8()">ReadableBuffer</a></code></span></div> |
| <div class="block">Reads a UTF-8 encoded String from the buffer starting the decode at the |
| current position and reading until the limit is reached. The position |
| is advanced to the limit once this method returns. If there is no bytes |
| remaining in the buffer when this method is called a null is returned.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ReadableBuffer.html#readUTF8()">readUTF8</a></code> in interface <code><a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a string decoded from the remaining bytes in this buffer.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.nio.charset.CharacterCodingException</code> - if the encoding is invalid for any reason.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="readString(java.nio.charset.CharsetDecoder)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readString</h4> |
| <pre class="methodSignature">public java.lang.String readString​(java.nio.charset.CharsetDecoder decoder) |
| throws java.nio.charset.CharacterCodingException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ReadableBuffer.html#readString(java.nio.charset.CharsetDecoder)">ReadableBuffer</a></code></span></div> |
| <div class="block">Decodes a String from the buffer using the provided <code>CharsetDecoder</code> |
| starting the decode at the current position and reading until the limit is |
| reached. The position is advanced to the limit once this method returns. |
| If there is no bytes remaining in the buffer when this method is called a |
| null is returned.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ReadableBuffer.html#readString(java.nio.charset.CharsetDecoder)">readString</a></code> in interface <code><a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a string decoded from the remaining bytes in this buffer.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.nio.charset.CharacterCodingException</code> - if the encoding is invalid for any reason.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="reclaimRead()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reclaimRead</h4> |
| <pre class="methodSignature">public <a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec">CompositeReadableBuffer</a> reclaimRead()</pre> |
| <div class="block">Compact the buffer dropping arrays that have been consumed by previous |
| reads from this Composite buffer. The limit is reset to the new capacity</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ReadableBuffer.html#reclaimRead()">reclaimRead</a></code> in interface <code><a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this buffer</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="append(byte[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>append</h4> |
| <pre class="methodSignature">public <a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec">CompositeReadableBuffer</a> append​(byte[] array)</pre> |
| <div class="block">Adds the given array into the composite buffer at the end. |
| <p> |
| The appended array is not copied so changes to the source array are visible in this |
| buffer and vice versa. If this composite was empty than it would return true for the |
| <a href="#hasArray()"><code>hasArray()</code></a> method until another array is appended. |
| <p> |
| Calling this method resets the limit to the new capacity.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>array</code> - The array to add to this composite buffer.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this <a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec"><code>CompositeReadableBuffer</code></a>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if the array is null or zero size.</dd> |
| <dd><code>java.lang.IllegalStateException</code> - if the buffer does not allow appends.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="append(org.apache.qpid.proton.codec.CompositeReadableBuffer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>append</h4> |
| <pre class="methodSignature">public <a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec">CompositeReadableBuffer</a> append​(<a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec">CompositeReadableBuffer</a> buffer)</pre> |
| <div class="block">Adds the given composite buffer contents (from current position, up to the limit) into this |
| composite buffer at the end. The source buffer position will be set to its limit. |
| <p> |
| The appended buffer contents are not copied wherever possible, so changes to the source |
| arrays are typically visible in this buffer and vice versa. Exceptions include where the |
| source buffer position is not located at the start of its current backing array, or where the |
| given buffer has a limit that doesn't encompass all of the last array used, and |
| so the remainder of that arrays contents must be copied first to append here. |
| <p> |
| Calling this method resets the limit to the new capacity.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>buffer</code> - the buffer with contents to append into this composite buffer.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this <a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec"><code>CompositeReadableBuffer</code></a>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if the given buffer is null or has zero remainder.</dd> |
| <dd><code>java.lang.IllegalStateException</code> - if the buffer does not allow appends.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="append(org.apache.qpid.proton.codec.ReadableBuffer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>append</h4> |
| <pre class="methodSignature">public <a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec">CompositeReadableBuffer</a> append​(<a href="ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a> buffer)</pre> |
| <div class="block">Adds the given readable buffer contents (from current position, up to the limit) into this |
| composite buffer at the end. The source buffer position will be set to its limit. |
| <p> |
| The appended buffer contents are not copied wherever possible, so changes to the source |
| arrays are typically visible in this buffer and vice versa. Exceptions are where the |
| source buffer is not backed by an array, or where the source buffer position is not |
| located at the start of its backing array, and so the remainder of the contents must |
| be copied first to append here. |
| <p> |
| Calling this method resets the limit to the new capacity.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>buffer</code> - the buffer with contents to append into this composite buffer.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this <a href="CompositeReadableBuffer.html" title="class in org.apache.qpid.proton.codec"><code>CompositeReadableBuffer</code></a>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if the given buffer is null or has zero remainder.</dd> |
| <dd><code>java.lang.IllegalStateException</code> - if the buffer does not allow appends.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="hashCode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre class="methodSignature">public int hashCode()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="equals(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre class="methodSignature">public boolean equals​(java.lang.Object other)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>equals</code> in class <code>java.lang.Object</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toString()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre class="methodSignature">public java.lang.String toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>toString</code> in class <code>java.lang.Object</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="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</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><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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| </footer> |
| </body> |
| </html> |