| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.11) on Wed May 12 10:10:59 EDT 2021 --> |
| <title>ProtonByteBuffer (Qpid ProtonJ2 Parent 1.0.0-M1 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2021-05-12"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ProtonByteBuffer (Qpid ProtonJ2 Parent 1.0.0-M1 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}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ProtonByteBuffer.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>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 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.protonj2.buffer</a></div> |
| <h2 title="Class ProtonByteBuffer" class="title">Class ProtonByteBuffer</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="ProtonAbstractBuffer.html" title="class in org.apache.qpid.protonj2.buffer">org.apache.qpid.protonj2.buffer.ProtonAbstractBuffer</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.qpid.protonj2.buffer.ProtonByteBuffer</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code>java.lang.Comparable<<a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a>></code>, <code><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">ProtonByteBuffer</span> |
| extends <a href="ProtonAbstractBuffer.html" title="class in org.apache.qpid.protonj2.buffer">ProtonAbstractBuffer</a></pre> |
| <div class="block">Implementation of the ProtonBuffer interface that uses an array backing |
| the buffer that is dynamically resized as bytes are written.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_CAPACITY">DEFAULT_CAPACITY</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The default initial capacity used for the underlying byte array.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_MAXIMUM_CAPACITY">DEFAULT_MAXIMUM_CAPACITY</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The default maximum capacity that this buffer can grow to.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.apache.qpid.protonj2.buffer.ProtonAbstractBuffer"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.qpid.protonj2.buffer.<a href="ProtonAbstractBuffer.html" title="class in org.apache.qpid.protonj2.buffer">ProtonAbstractBuffer</a></h3> |
| <code><a href="ProtonAbstractBuffer.html#markedReadIndex">markedReadIndex</a>, <a href="ProtonAbstractBuffer.html#markedWriteIndex">markedWriteIndex</a>, <a href="ProtonAbstractBuffer.html#readIndex">readIndex</a>, <a href="ProtonAbstractBuffer.html#writeIndex">writeIndex</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <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">Modifier</th> |
| <th class="colSecond" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code> </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">ProtonByteBuffer</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new <a href="ProtonByteBuffer.html" title="class in org.apache.qpid.protonj2.buffer"><code>ProtonByteBuffer</code></a> instance that uses default configuration values for |
| initial capacity and the maximum allowed capacity to which the underlying byte array will |
| grow before errors will be thrown from operations that would expand the storage.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code> </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(byte%5B%5D)">ProtonByteBuffer</a></span>​(byte[] array)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new <a href="ProtonByteBuffer.html" title="class in org.apache.qpid.protonj2.buffer"><code>ProtonByteBuffer</code></a> with the given byte array as the backing store to be used |
| initially.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(byte%5B%5D,int)">ProtonByteBuffer</a></span>​(byte[] array, |
| int maximumCapacity)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(byte%5B%5D,int,int)">ProtonByteBuffer</a></span>​(byte[] array, |
| int maximumCapacity, |
| int writeIndex)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code> </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(int)">ProtonByteBuffer</a></span>​(int initialCapacity)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new <a href="ProtonByteBuffer.html" title="class in org.apache.qpid.protonj2.buffer"><code>ProtonByteBuffer</code></a> with the given initial capacity and uses the default |
| value for the maximum capacity restriction.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code> </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(int,int)">ProtonByteBuffer</a></span>​(int initialCapacity, |
| int maximumCapacity)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new <a href="ProtonByteBuffer.html" title="class in org.apache.qpid.protonj2.buffer"><code>ProtonByteBuffer</code></a> with the given initial capacity and the given maximum |
| capacity restriction.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#capacity()">capacity</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#capacity(int)">capacity</a></span>​(int newCapacity)</code></th> |
| <td class="colLast"> |
| <div class="block">Adjusts the capacity of this buffer.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copy(int,int)">copy</a></span>​(int index, |
| int length)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a copy of this buffer's sub-region.</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="#getArray()">getArray</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the backing array for this ProtonBuffer instance if there is such an array or |
| throws an exception if this ProtonBuffer implementation has no backing array.</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="#getArrayOffset()">getArrayOffset</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>byte</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getByte(int)">getByte</a></span>​(int index)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets a byte from the specified index, this method will not modify the read or write |
| index.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBytes(int,byte%5B%5D,int,int)">getBytes</a></span>​(int index, |
| byte[] destination, |
| int destinationIndex, |
| int length)</code></th> |
| <td class="colLast"> |
| <div class="block">Transfers this buffer's data to the specified destination starting at |
| the specified absolute <code>index</code>.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBytes(int,java.nio.ByteBuffer)">getBytes</a></span>​(int index, |
| java.nio.ByteBuffer destination)</code></th> |
| <td class="colLast"> |
| <div class="block">Transfers this buffer's data to the specified destination starting at |
| the specified absolute <code>index</code> until the destination's position |
| reaches its limit.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBytes(int,org.apache.qpid.protonj2.buffer.ProtonBuffer,int,int)">getBytes</a></span>​(int index, |
| <a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> destination, |
| int destinationIndex, |
| int length)</code></th> |
| <td class="colLast"> |
| <div class="block">Transfers this buffer's data to the specified destination starting at |
| the specified absolute <code>index</code>.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInt(int)">getInt</a></span>​(int index)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets a int from the specified index, this method will not modify the read or write |
| index.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLong(int)">getLong</a></span>​(int index)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets a long from the specified index, this method will not modify the read or write |
| index.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>short</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getShort(int)">getShort</a></span>​(int index)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets a short from the specified index, this method will not modify the read or write |
| index.</div> |
| </td> |
| </tr> |
| <tr id="i12" 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"> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setByte(int,int)">setByte</a></span>​(int index, |
| int value)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the byte value at the given write index in this buffer's backing data store.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setBytes(int,byte%5B%5D,int,int)">setBytes</a></span>​(int index, |
| byte[] source, |
| int sourceIndex, |
| int length)</code></th> |
| <td class="colLast"> |
| <div class="block">Transfers the specified source array's data to this buffer starting at |
| the specified absolute <code>index</code>.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setBytes(int,java.nio.ByteBuffer)">setBytes</a></span>​(int index, |
| java.nio.ByteBuffer src)</code></th> |
| <td class="colLast"> |
| <div class="block">Transfers the specified source buffer's data to this buffer starting at |
| the specified absolute <code>index</code> until the source buffer's position |
| reaches its limit.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setBytes(int,org.apache.qpid.protonj2.buffer.ProtonBuffer,int,int)">setBytes</a></span>​(int index, |
| <a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> source, |
| int sourceIndex, |
| int length)</code></th> |
| <td class="colLast"> |
| <div class="block">Transfers the specified source buffer's data to this buffer starting at |
| the specified absolute <code>index</code>.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setInt(int,int)">setInt</a></span>​(int index, |
| int value)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the int value at the given write index in this buffer's backing data store.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLong(int,long)">setLong</a></span>​(int index, |
| long value)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the long value at the given write index in this buffer's backing data store.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setShort(int,int)">setShort</a></span>​(int index, |
| int value)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the short value at the given write index in this buffer's backing data store.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>java.nio.ByteBuffer</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toByteBuffer(int,int)">toByteBuffer</a></span>​(int index, |
| int length)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a ByteBuffer that represents the given span of bytes from the readable portion |
| of this buffer.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.qpid.protonj2.buffer.ProtonAbstractBuffer"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.qpid.protonj2.buffer.<a href="ProtonAbstractBuffer.html" title="class in org.apache.qpid.protonj2.buffer">ProtonAbstractBuffer</a></h3> |
| <code><a href="ProtonAbstractBuffer.html#adjustIndexMarks(int)">adjustIndexMarks</a>, <a href="ProtonAbstractBuffer.html#checkDestinationIndex(int,int,int,int)">checkDestinationIndex</a>, <a href="ProtonAbstractBuffer.html#checkIndex(int,int)">checkIndex</a>, <a href="ProtonAbstractBuffer.html#checkNewCapacity(int)">checkNewCapacity</a>, <a href="ProtonAbstractBuffer.html#checkReadableBytes(int)">checkReadableBytes</a>, <a href="ProtonAbstractBuffer.html#checkSourceIndex(int,int,int,int)">checkSourceIndex</a>, <a href="ProtonAbstractBuffer.html#clear()">clear</a>, <a href="ProtonAbstractBuffer.html#compareTo(org.apache.qpid.protonj2.buffer.ProtonBuffer)">compareTo</a>, <a href="ProtonAbstractBuffer.html#copy()">copy</a>, <a href="ProtonAbstractBuffer.html#duplicate()">duplicate</a>, <a href="ProtonAbstractBuffer.html#ensureWritable(int)">ensureWritable</a>, <a href="ProtonAbstractBuffer.html#equals(java.lang.Object)">equals</a>, <a href="ProtonAbstractBuffer.html#getBoolean(int)">getBoolean</a>, <a href="ProtonAbstractBuffer.html#getBytes(int,byte%5B%5D)">getBytes</a>, <a href="ProtonAbstractBuffer.html#getBytes(int,org.apache.qpid.protonj2.buffer.ProtonBuffer)">getBytes</a>, <a href="ProtonAbstractBuffer.html#getBytes(int,org.apache.qpid.protonj2.buffer.ProtonBuffer,int)">getBytes</a>, <a href="ProtonAbstractBuffer.html#getChar(int)">getChar</a>, <a href="ProtonAbstractBuffer.html#getDouble(int)">getDouble</a>, <a href="ProtonAbstractBuffer.html#getFloat(int)">getFloat</a>, <a href="ProtonAbstractBuffer.html#getMaxWritableBytes()">getMaxWritableBytes</a>, <a href="ProtonAbstractBuffer.html#getReadableBytes()">getReadableBytes</a>, <a href="ProtonAbstractBuffer.html#getReadIndex()">getReadIndex</a>, <a href="ProtonAbstractBuffer.html#getUnsignedByte(int)">getUnsignedByte</a>, <a href="ProtonAbstractBuffer.html#getUnsignedInt(int)">getUnsignedInt</a>, <a href="ProtonAbstractBuffer.html#getUnsignedShort(int)">getUnsignedShort</a>, <a href="ProtonAbstractBuffer.html#getWritableBytes()">getWritableBytes</a>, <a href="ProtonAbstractBuffer.html#getWriteIndex()">getWriteIndex</a>, <a href="ProtonAbstractBuffer.html#hashCode()">hashCode</a>, <a href="ProtonAbstractBuffer.html#isOutOfBounds(int,int,int)">isOutOfBounds</a>, <a href="ProtonAbstractBuffer.html#isReadable()">isReadable</a>, <a href="ProtonAbstractBuffer.html#isReadable(int)">isReadable</a>, <a href="ProtonAbstractBuffer.html#isWritable()">isWritable</a>, <a href="ProtonAbstractBuffer.html#isWritable(int)">isWritable</a>, <a href="ProtonAbstractBuffer.html#markReadIndex()">markReadIndex</a>, <a href="ProtonAbstractBuffer.html#markWriteIndex()">markWriteIndex</a>, <a href="ProtonAbstractBuffer.html#maxCapacity()">maxCapacity</a>, <a href="ProtonAbstractBuffer.html#readBoolean()">readBoolean</a>, <a href="ProtonAbstractBuffer.html#readByte()">readByte</a>, <a href="ProtonAbstractBuffer.html#readBytes(byte%5B%5D)">readBytes</a>, <a href="ProtonAbstractBuffer.html#readBytes(byte%5B%5D,int)">readBytes</a>, <a href="ProtonAbstractBuffer.html#readBytes(byte%5B%5D,int,int)">readBytes</a>, <a href="ProtonAbstractBuffer.html#readBytes(java.nio.ByteBuffer)">readBytes</a>, <a href="ProtonAbstractBuffer.html#readBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer)">readBytes</a>, <a href="ProtonAbstractBuffer.html#readBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer,int)">readBytes</a>, <a href="ProtonAbstractBuffer.html#readBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer,int,int)">readBytes</a>, <a href="ProtonAbstractBuffer.html#readDouble()">readDouble</a>, <a href="ProtonAbstractBuffer.html#readFloat()">readFloat</a>, <a href="ProtonAbstractBuffer.html#readInt()">readInt</a>, <a href="ProtonAbstractBuffer.html#readLong()">readLong</a>, <a href="ProtonAbstractBuffer.html#readShort()">readShort</a>, <a href="ProtonAbstractBuffer.html#resetReadIndex()">resetReadIndex</a>, <a href="ProtonAbstractBuffer.html#resetWriteIndex()">resetWriteIndex</a>, <a href="ProtonAbstractBuffer.html#setBoolean(int,boolean)">setBoolean</a>, <a href="ProtonAbstractBuffer.html#setBytes(int,byte%5B%5D)">setBytes</a>, <a href="ProtonAbstractBuffer.html#setBytes(int,org.apache.qpid.protonj2.buffer.ProtonBuffer)">setBytes</a>, <a href="ProtonAbstractBuffer.html#setBytes(int,org.apache.qpid.protonj2.buffer.ProtonBuffer,int)">setBytes</a>, <a href="ProtonAbstractBuffer.html#setChar(int,int)">setChar</a>, <a href="ProtonAbstractBuffer.html#setDouble(int,double)">setDouble</a>, <a href="ProtonAbstractBuffer.html#setFloat(int,float)">setFloat</a>, <a href="ProtonAbstractBuffer.html#setIndex(int,int)">setIndex</a>, <a href="ProtonAbstractBuffer.html#setReadIndex(int)">setReadIndex</a>, <a href="ProtonAbstractBuffer.html#setWriteIndex(int)">setWriteIndex</a>, <a href="ProtonAbstractBuffer.html#skipBytes(int)">skipBytes</a>, <a href="ProtonAbstractBuffer.html#slice()">slice</a>, <a href="ProtonAbstractBuffer.html#slice(int,int)">slice</a>, <a href="ProtonAbstractBuffer.html#toByteBuffer()">toByteBuffer</a>, <a href="ProtonAbstractBuffer.html#toString()">toString</a>, <a href="ProtonAbstractBuffer.html#toString(java.nio.charset.Charset)">toString</a>, <a href="ProtonAbstractBuffer.html#writeBoolean(boolean)">writeBoolean</a>, <a href="ProtonAbstractBuffer.html#writeByte(int)">writeByte</a>, <a href="ProtonAbstractBuffer.html#writeBytes(byte%5B%5D)">writeBytes</a>, <a href="ProtonAbstractBuffer.html#writeBytes(byte%5B%5D,int)">writeBytes</a>, <a href="ProtonAbstractBuffer.html#writeBytes(byte%5B%5D,int,int)">writeBytes</a>, <a href="ProtonAbstractBuffer.html#writeBytes(java.nio.ByteBuffer)">writeBytes</a>, <a href="ProtonAbstractBuffer.html#writeBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer)">writeBytes</a>, <a href="ProtonAbstractBuffer.html#writeBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer,int)">writeBytes</a>, <a href="ProtonAbstractBuffer.html#writeBytes(org.apache.qpid.protonj2.buffer.ProtonBuffer,int,int)">writeBytes</a>, <a href="ProtonAbstractBuffer.html#writeDouble(double)">writeDouble</a>, <a href="ProtonAbstractBuffer.html#writeFloat(float)">writeFloat</a>, <a href="ProtonAbstractBuffer.html#writeInt(int)">writeInt</a>, <a href="ProtonAbstractBuffer.html#writeLong(long)">writeLong</a>, <a href="ProtonAbstractBuffer.html#writeShort(short)">writeShort</a></code></li> |
| </ul> |
| <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> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.qpid.protonj2.buffer.ProtonBuffer"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.qpid.protonj2.buffer.<a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></h3> |
| <code><a href="ProtonBuffer.html#unwrap()">unwrap</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="DEFAULT_CAPACITY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_CAPACITY</h4> |
| <pre>public static final int DEFAULT_CAPACITY</pre> |
| <div class="block">The default initial capacity used for the underlying byte array.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.buffer.ProtonByteBuffer.DEFAULT_CAPACITY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="DEFAULT_MAXIMUM_CAPACITY"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DEFAULT_MAXIMUM_CAPACITY</h4> |
| <pre>public static final int DEFAULT_MAXIMUM_CAPACITY</pre> |
| <div class="block">The default maximum capacity that this buffer can grow to.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.qpid.protonj2.buffer.ProtonByteBuffer.DEFAULT_MAXIMUM_CAPACITY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ProtonByteBuffer</h4> |
| <pre>public ProtonByteBuffer()</pre> |
| <div class="block">Creates a new <a href="ProtonByteBuffer.html" title="class in org.apache.qpid.protonj2.buffer"><code>ProtonByteBuffer</code></a> instance that uses default configuration values for |
| initial capacity and the maximum allowed capacity to which the underlying byte array will |
| grow before errors will be thrown from operations that would expand the storage.</div> |
| </li> |
| </ul> |
| <a id="<init>(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ProtonByteBuffer</h4> |
| <pre>public ProtonByteBuffer​(int initialCapacity)</pre> |
| <div class="block">Creates a new <a href="ProtonByteBuffer.html" title="class in org.apache.qpid.protonj2.buffer"><code>ProtonByteBuffer</code></a> with the given initial capacity and uses the default |
| value for the maximum capacity restriction.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>initialCapacity</code> - The initial size of the backing byte store.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if the given value is less than zero.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(int,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ProtonByteBuffer</h4> |
| <pre>public ProtonByteBuffer​(int initialCapacity, |
| int maximumCapacity)</pre> |
| <div class="block">Creates a new <a href="ProtonByteBuffer.html" title="class in org.apache.qpid.protonj2.buffer"><code>ProtonByteBuffer</code></a> with the given initial capacity and the given maximum |
| capacity restriction.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>initialCapacity</code> - The initial size of the backing byte store.</dd> |
| <dd><code>maximumCapacity</code> - The maximum size the backing byte store is allowed to grow.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if the given value is less than zero or greater than the maximum.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(byte[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ProtonByteBuffer</h4> |
| <pre>public ProtonByteBuffer​(byte[] array)</pre> |
| <div class="block">Creates a new <a href="ProtonByteBuffer.html" title="class in org.apache.qpid.protonj2.buffer"><code>ProtonByteBuffer</code></a> with the given byte array as the backing store to be used |
| initially. The buffer uses the default value for maximum capacity meaning as the buffer is written |
| to the backing store will eventually be reallocated and no longer wrap the original array. The |
| resulting buffer will have a read index of zero and a write index set to the size of the backing |
| array.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>array</code> - The initial array use use as the backing store for this byte buffer.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(byte[],int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ProtonByteBuffer</h4> |
| <pre>protected ProtonByteBuffer​(byte[] array, |
| int maximumCapacity)</pre> |
| </li> |
| </ul> |
| <a id="<init>(byte[],int,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ProtonByteBuffer</h4> |
| <pre>protected ProtonByteBuffer​(byte[] array, |
| int maximumCapacity, |
| int writeIndex)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="capacity()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>capacity</h4> |
| <pre class="methodSignature">public int capacity()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of bytes this buffer can currently contain.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="capacity(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>capacity</h4> |
| <pre class="methodSignature">public <a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> capacity​(int newCapacity)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ProtonBuffer.html#capacity(int)">ProtonBuffer</a></code></span></div> |
| <div class="block">Adjusts the capacity of this buffer. If the new capacity is less than the current |
| capacity, the content of this buffer is truncated. If the new capacity is greater |
| than the current capacity, the buffer is appended with unspecified data whose length is |
| new capacity - current capacity.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newCapacity</code> - the new maximum capacity value of this buffer.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this buffer for using in call chaining.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="copy(int,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copy</h4> |
| <pre class="methodSignature">public <a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> copy​(int index, |
| int length)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ProtonBuffer.html#copy(int,int)">ProtonBuffer</a></code></span></div> |
| <div class="block">Returns a copy of this buffer's sub-region. Modifying the content of |
| the returned buffer or this buffer does not affect each other at all. |
| This method does not modify the value returned from <a href="ProtonBuffer.html#getReadIndex()"><code>ProtonBuffer.getReadIndex()</code></a> |
| or <a href="ProtonBuffer.html#getWriteIndex()"><code>ProtonBuffer.getWriteIndex()</code></a> of this buffer.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ProtonBuffer.html#copy(int,int)">copy</a></code> in interface <code><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ProtonAbstractBuffer.html#copy(int,int)">copy</a></code> in class <code><a href="ProtonAbstractBuffer.html" title="class in org.apache.qpid.protonj2.buffer">ProtonAbstractBuffer</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - The index in this buffer where the copy should begin</dd> |
| <dd><code>length</code> - The number of bytes to copy to the new buffer from this one.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new ProtonBuffer instance containing the copied bytes.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toByteBuffer(int,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toByteBuffer</h4> |
| <pre class="methodSignature">public java.nio.ByteBuffer toByteBuffer​(int index, |
| int length)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ProtonBuffer.html#toByteBuffer(int,int)">ProtonBuffer</a></code></span></div> |
| <div class="block">Returns a ByteBuffer that represents the given span of bytes from the readable portion |
| of this buffer. |
| <p> |
| This method should attempt to return a ByteBuffer that shares the backing data store |
| with this buffer however if that is not possible it is permitted that the returned |
| ByteBuffer contain a copy of the readable bytes of this ProtonBuffer.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ProtonBuffer.html#toByteBuffer(int,int)">toByteBuffer</a></code> in interface <code><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ProtonAbstractBuffer.html#toByteBuffer(int,int)">toByteBuffer</a></code> in class <code><a href="ProtonAbstractBuffer.html" title="class in org.apache.qpid.protonj2.buffer">ProtonAbstractBuffer</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - The starting index in this where the ByteBuffer view should begin.</dd> |
| <dd><code>length</code> - The number of bytes to include in the ByteBuffer view.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a ByteBuffer that represents the given view of this buffers readable bytes.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="hasArray()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasArray</h4> |
| <pre class="methodSignature">public boolean hasArray()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if this buffer has a backing byte array that can be accessed.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getArray()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getArray</h4> |
| <pre class="methodSignature">public byte[] getArray()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ProtonBuffer.html#getArray()">ProtonBuffer</a></code></span></div> |
| <div class="block">Returns the backing array for this ProtonBuffer instance if there is such an array or |
| throws an exception if this ProtonBuffer implementation has no backing array. |
| <p> |
| Changes to the returned array are visible to other users of this ProtonBuffer.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the backing byte array for this ProtonBuffer.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getArrayOffset()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getArrayOffset</h4> |
| <pre class="methodSignature">public int getArrayOffset()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the offset of the first byte in the backing array belonging to this buffer.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getByte(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getByte</h4> |
| <pre class="methodSignature">public byte getByte​(int index)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ProtonBuffer.html#getByte(int)">ProtonBuffer</a></code></span></div> |
| <div class="block">Gets a byte from the specified index, this method will not modify the read or write |
| index.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - The index into the buffer where the value should be read.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value read from the given index.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getShort(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getShort</h4> |
| <pre class="methodSignature">public short getShort​(int index)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ProtonBuffer.html#getShort(int)">ProtonBuffer</a></code></span></div> |
| <div class="block">Gets a short from the specified index, this method will not modify the read or write |
| index.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - The index into the buffer where the value should be read.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value read from the given index.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getInt(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInt</h4> |
| <pre class="methodSignature">public int getInt​(int index)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ProtonBuffer.html#getInt(int)">ProtonBuffer</a></code></span></div> |
| <div class="block">Gets a int from the specified index, this method will not modify the read or write |
| index.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - The index into the buffer where the value should be read.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value read from the given index.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getLong(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLong</h4> |
| <pre class="methodSignature">public long getLong​(int index)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ProtonBuffer.html#getLong(int)">ProtonBuffer</a></code></span></div> |
| <div class="block">Gets a long from the specified index, this method will not modify the read or write |
| index.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - The index into the buffer where the value should be read.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value read from the given index.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getBytes(int,org.apache.qpid.protonj2.buffer.ProtonBuffer,int,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBytes</h4> |
| <pre class="methodSignature">public <a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> getBytes​(int index, |
| <a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> destination, |
| int destinationIndex, |
| int length)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ProtonBuffer.html#getBytes(int,org.apache.qpid.protonj2.buffer.ProtonBuffer,int,int)">ProtonBuffer</a></code></span></div> |
| <div class="block">Transfers this buffer's data to the specified destination starting at |
| the specified absolute <code>index</code>. |
| This method does not modify <code>readIndex</code> or <code>writeIndex</code> |
| of both the source (i.e. <code>this</code>) and the destination.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - The index into the buffer where the value should be read.</dd> |
| <dd><code>destination</code> - The buffer where the bytes read will be written to</dd> |
| <dd><code>destinationIndex</code> - The index into the destination where the write starts</dd> |
| <dd><code>length</code> - The number of bytes to transfer</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this buffer for chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getBytes(int,byte[],int,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBytes</h4> |
| <pre class="methodSignature">public <a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> getBytes​(int index, |
| byte[] destination, |
| int destinationIndex, |
| int length)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ProtonBuffer.html#getBytes(int,byte%5B%5D,int,int)">ProtonBuffer</a></code></span></div> |
| <div class="block">Transfers this buffer's data to the specified destination starting at |
| the specified absolute <code>index</code>. |
| This method does not modify <code>#getReadIndex()</code> or <code>#getWriteIndex()</code> |
| of this buffer.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - The index into the buffer where the value should be read.</dd> |
| <dd><code>destination</code> - The buffer where the bytes read will be written to</dd> |
| <dd><code>destinationIndex</code> - the offset into the destination to begin writing the bytes.</dd> |
| <dd><code>length</code> - the number of bytes to transfer from this buffer to the target buffer.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this buffer for chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getBytes(int,java.nio.ByteBuffer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBytes</h4> |
| <pre class="methodSignature">public <a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> getBytes​(int index, |
| java.nio.ByteBuffer destination)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ProtonBuffer.html#getBytes(int,java.nio.ByteBuffer)">ProtonBuffer</a></code></span></div> |
| <div class="block">Transfers this buffer's data to the specified destination starting at |
| the specified absolute <code>index</code> until the destination's position |
| reaches its limit. |
| This method does not modify <code>#getReadIndex()</code> or <code>#getWriteIndex()</code> of |
| this buffer while the destination's <code>position</code> will be increased.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - The index into the buffer where the value should be read.</dd> |
| <dd><code>destination</code> - The buffer where the bytes read will be written to</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this buffer for chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setByte(int,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setByte</h4> |
| <pre class="methodSignature">public <a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> setByte​(int index, |
| int value)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ProtonBuffer.html#setByte(int,int)">ProtonBuffer</a></code></span></div> |
| <div class="block">Sets the byte value at the given write index in this buffer's backing data store.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - The index to start the write from.</dd> |
| <dd><code>value</code> - The value to write at the given index.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this ProtonBuffer for chaining.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setShort(int,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setShort</h4> |
| <pre class="methodSignature">public <a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> setShort​(int index, |
| int value)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ProtonBuffer.html#setShort(int,int)">ProtonBuffer</a></code></span></div> |
| <div class="block">Sets the short value at the given write index in this buffer's backing data store.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - The index to start the write from.</dd> |
| <dd><code>value</code> - The value to write at the given index.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this ProtonBuffer for chaining.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setInt(int,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInt</h4> |
| <pre class="methodSignature">public <a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> setInt​(int index, |
| int value)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ProtonBuffer.html#setInt(int,int)">ProtonBuffer</a></code></span></div> |
| <div class="block">Sets the int value at the given write index in this buffer's backing data store.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - The index to start the write from.</dd> |
| <dd><code>value</code> - The value to write at the given index.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this ProtonBuffer for chaining.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setLong(int,long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLong</h4> |
| <pre class="methodSignature">public <a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> setLong​(int index, |
| long value)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ProtonBuffer.html#setLong(int,long)">ProtonBuffer</a></code></span></div> |
| <div class="block">Sets the long value at the given write index in this buffer's backing data store.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - The index to start the write from.</dd> |
| <dd><code>value</code> - The value to write at the given index.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to this ProtonBuffer for chaining.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setBytes(int,org.apache.qpid.protonj2.buffer.ProtonBuffer,int,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBytes</h4> |
| <pre class="methodSignature">public <a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> setBytes​(int index, |
| <a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> source, |
| int sourceIndex, |
| int length)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ProtonBuffer.html#setBytes(int,org.apache.qpid.protonj2.buffer.ProtonBuffer,int,int)">ProtonBuffer</a></code></span></div> |
| <div class="block">Transfers the specified source buffer's data to this buffer starting at |
| the specified absolute <code>index</code>. |
| This method does not modify <code>readIndex</code> or <code>writeIndex</code> |
| of both the source (i.e. <code>this</code>) and the destination.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - The index in this buffer where the write operation starts.</dd> |
| <dd><code>source</code> - The source buffer from which the bytes are read.</dd> |
| <dd><code>sourceIndex</code> - The first index of the source</dd> |
| <dd><code>length</code> - The number of bytes to transfer</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this buffer for chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setBytes(int,byte[],int,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBytes</h4> |
| <pre class="methodSignature">public <a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> setBytes​(int index, |
| byte[] source, |
| int sourceIndex, |
| int length)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ProtonBuffer.html#setBytes(int,byte%5B%5D,int,int)">ProtonBuffer</a></code></span></div> |
| <div class="block">Transfers the specified source array's data to this buffer starting at |
| the specified absolute <code>index</code>. |
| This method does not modify <code>readIndex</code> or <code>writeIndex</code> of |
| this buffer.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - The index in this buffer where the write operation starts.</dd> |
| <dd><code>source</code> - The source buffer from which the bytes are read.</dd> |
| <dd><code>sourceIndex</code> - The first index of the source</dd> |
| <dd><code>length</code> - The number of bytes to transfer</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this buffer for chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setBytes(int,java.nio.ByteBuffer)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setBytes</h4> |
| <pre class="methodSignature">public <a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> setBytes​(int index, |
| java.nio.ByteBuffer src)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ProtonBuffer.html#setBytes(int,java.nio.ByteBuffer)">ProtonBuffer</a></code></span></div> |
| <div class="block">Transfers the specified source buffer's data to this buffer starting at |
| the specified absolute <code>index</code> until the source buffer's position |
| reaches its limit. |
| This method does not modify <code>readIndex</code> or <code>writeIndex</code> of |
| this buffer.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>index</code> - The index in this buffer where the write operation starts.</dd> |
| <dd><code>src</code> - The source buffer from which the bytes are read.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this buffer for chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ProtonByteBuffer.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |