| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.11) on Wed May 12 10:10:59 EDT 2021 --> |
| <title>ProtonByteBufferAllocator (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="ProtonByteBufferAllocator (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}; |
| 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/ProtonByteBufferAllocator.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 ProtonByteBufferAllocator" class="title">Class ProtonByteBufferAllocator</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.qpid.protonj2.buffer.ProtonByteBufferAllocator</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="ProtonBufferAllocator.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferAllocator</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public final class <span class="typeNameLabel">ProtonByteBufferAllocator</span> |
| extends java.lang.Object |
| implements <a href="ProtonBufferAllocator.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferAllocator</a></pre> |
| <div class="block">Allocator for the default buffer type in Proton</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 <a href="ProtonByteBufferAllocator.html" title="class in org.apache.qpid.protonj2.buffer">ProtonByteBufferAllocator</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT">DEFAULT</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Default <a href="ProtonByteBufferAllocator.html" title="class in org.apache.qpid.protonj2.buffer"><code>ProtonByteBufferAllocator</code></a> instance that uses defaults for all configuration |
| when creating new <a href="ProtonByteBuffer.html" title="class in org.apache.qpid.protonj2.buffer"><code>ProtonByteBuffer</code></a> instances.</div> |
| </td> |
| </tr> |
| </table> |
| </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">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()">ProtonByteBufferAllocator</a></span>()</code></th> |
| <td class="colLast"> </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><a href="ProtonByteBuffer.html" title="class in org.apache.qpid.protonj2.buffer">ProtonByteBuffer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#allocate()">allocate</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new ProtonBuffer instance with default initial capacity.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="ProtonByteBuffer.html" title="class in org.apache.qpid.protonj2.buffer">ProtonByteBuffer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#allocate(int)">allocate</a></span>​(int initialCapacity)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new ProtonBuffer instance with the given initial capacity and the |
| maximum capacity should be that of the underlying buffer implementations |
| limit.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonByteBuffer.html" title="class in org.apache.qpid.protonj2.buffer">ProtonByteBuffer</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#allocate(int,int)">allocate</a></span>​(int initialCapacity, |
| int maximumCapacity)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new ProtonBuffer instance with the given initial capacity and the |
| maximum capacity should that of the value specified by the caller.</div> |
| </td> |
| </tr> |
| <tr id="i3" 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="#outputBuffer(int)">outputBuffer</a></span>​(int initialCapacity)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new output ProtonBuffer instance with the given initial capacity and the |
| maximum capacity should be that of the underlying buffer implementations limit.</div> |
| </td> |
| </tr> |
| <tr id="i4" 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="#outputBuffer(int,int)">outputBuffer</a></span>​(int initialCapacity, |
| int maximumCapacity)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new output ProtonBuffer instance with the given initial capacity and the |
| maximum capacity should that of the value specified by the caller.</div> |
| </td> |
| </tr> |
| <tr id="i5" 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="#wrap(byte%5B%5D)">wrap</a></span>​(byte[] array)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new ProtonBuffer that wraps the given byte array.</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="#wrap(byte%5B%5D,int,int)">wrap</a></span>​(byte[] array, |
| int offset, |
| int length)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new ProtonBuffer that wraps the given byte array using the provided |
| offset and length values to confine the view of that array.</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="#wrap(java.nio.ByteBuffer)">wrap</a></span>​(java.nio.ByteBuffer buffer)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new ProtonBuffer that wraps the given ByteBuffer.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </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"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DEFAULT</h4> |
| <pre>public static final <a href="ProtonByteBufferAllocator.html" title="class in org.apache.qpid.protonj2.buffer">ProtonByteBufferAllocator</a> DEFAULT</pre> |
| <div class="block">Default <a href="ProtonByteBufferAllocator.html" title="class in org.apache.qpid.protonj2.buffer"><code>ProtonByteBufferAllocator</code></a> instance that uses defaults for all configuration |
| when creating new <a href="ProtonByteBuffer.html" title="class in org.apache.qpid.protonj2.buffer"><code>ProtonByteBuffer</code></a> instances.</div> |
| </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="blockListLast"> |
| <li class="blockList"> |
| <h4>ProtonByteBufferAllocator</h4> |
| <pre>public ProtonByteBufferAllocator()</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="allocate()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>allocate</h4> |
| <pre class="methodSignature">public <a href="ProtonByteBuffer.html" title="class in org.apache.qpid.protonj2.buffer">ProtonByteBuffer</a> allocate()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ProtonBufferAllocator.html#allocate()">ProtonBufferAllocator</a></code></span></div> |
| <div class="block">Create a new ProtonBuffer instance with default initial capacity. The buffer |
| implementation should support growing the buffer on an as needed basis to allow |
| writes without the user needing to code extra capacity and buffer reallocation |
| checks. |
| |
| It is not recommended that these buffers be backed by a pooled resource as there |
| is no defined release point within the buffer API and if used by an AMQP engine |
| they could be lost as buffers are copied or aggregated together.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ProtonBufferAllocator.html#allocate()">allocate</a></code> in interface <code><a href="ProtonBufferAllocator.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferAllocator</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new ProtonBuffer instance with default initial capacity.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="allocate(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>allocate</h4> |
| <pre class="methodSignature">public <a href="ProtonByteBuffer.html" title="class in org.apache.qpid.protonj2.buffer">ProtonByteBuffer</a> allocate​(int initialCapacity)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ProtonBufferAllocator.html#allocate(int)">ProtonBufferAllocator</a></code></span></div> |
| <div class="block">Create a new ProtonBuffer instance with the given initial capacity and the |
| maximum capacity should be that of the underlying buffer implementations |
| limit. |
| |
| It is not recommended that these buffers be backed by a pooled resource as there |
| is no defined release point within the buffer API and if used by an AMQP engine |
| they could be lost as buffers are copied or aggregated together.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ProtonBufferAllocator.html#allocate(int)">allocate</a></code> in interface <code><a href="ProtonBufferAllocator.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferAllocator</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>initialCapacity</code> - The initial capacity to use when creating the new ProtonBuffer.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new ProtonBuffer instance with the given initial capacity.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="allocate(int,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>allocate</h4> |
| <pre class="methodSignature">public <a href="ProtonByteBuffer.html" title="class in org.apache.qpid.protonj2.buffer">ProtonByteBuffer</a> allocate​(int initialCapacity, |
| int maximumCapacity)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ProtonBufferAllocator.html#allocate(int,int)">ProtonBufferAllocator</a></code></span></div> |
| <div class="block">Create a new ProtonBuffer instance with the given initial capacity and the |
| maximum capacity should that of the value specified by the caller. |
| |
| It is not recommended that these buffers be backed by a pooled resource as there |
| is no defined release point within the buffer API and if used by an AMQP engine |
| they could be lost as buffers are copied or aggregated together.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ProtonBufferAllocator.html#allocate(int,int)">allocate</a></code> in interface <code><a href="ProtonBufferAllocator.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferAllocator</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>initialCapacity</code> - The initial capacity to use when creating the new ProtonBuffer.</dd> |
| <dd><code>maximumCapacity</code> - The largest amount of bytes the new ProtonBuffer is allowed to grow to.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new ProtonBuffer instance with the given initial capacity.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="outputBuffer(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>outputBuffer</h4> |
| <pre class="methodSignature">public <a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> outputBuffer​(int initialCapacity)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ProtonBufferAllocator.html#outputBuffer(int)">ProtonBufferAllocator</a></code></span></div> |
| <div class="block">Create a new output ProtonBuffer instance with the given initial capacity and the |
| maximum capacity should be that of the underlying buffer implementations limit. The |
| buffer implementation should support growing the buffer on an as needed basis to allow |
| writes without the user needing to code extra capacity and buffer reallocation checks. |
| <p> |
| The returned buffer will be used for frame output from the Proton engine and |
| can be a pooled buffer which the IO handler will then need to release once |
| the buffer has been written.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ProtonBufferAllocator.html#outputBuffer(int)">outputBuffer</a></code> in interface <code><a href="ProtonBufferAllocator.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferAllocator</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>initialCapacity</code> - The initial capacity to use when creating the new ProtonBuffer.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new ProtonBuffer instance with the given initial capacity.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="outputBuffer(int,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>outputBuffer</h4> |
| <pre class="methodSignature">public <a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> outputBuffer​(int initialCapacity, |
| int maximumCapacity)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ProtonBufferAllocator.html#outputBuffer(int,int)">ProtonBufferAllocator</a></code></span></div> |
| <div class="block">Create a new output ProtonBuffer instance with the given initial capacity and the |
| maximum capacity should that of the value specified by the caller. |
| <p> |
| The returned buffer will be used for frame output from the Proton engine and |
| can be a pooled buffer which the IO handler will then need to release once |
| the buffer has been written.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ProtonBufferAllocator.html#outputBuffer(int,int)">outputBuffer</a></code> in interface <code><a href="ProtonBufferAllocator.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferAllocator</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>initialCapacity</code> - The initial capacity to use when creating the new ProtonBuffer.</dd> |
| <dd><code>maximumCapacity</code> - The largest amount of bytes the new ProtonBuffer is allowed to grow to.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new ProtonBuffer instance with the given initial capacity.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="wrap(byte[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>wrap</h4> |
| <pre class="methodSignature">public <a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> wrap​(byte[] array)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ProtonBufferAllocator.html#wrap(byte%5B%5D)">ProtonBufferAllocator</a></code></span></div> |
| <div class="block">Create a new ProtonBuffer that wraps the given byte array. |
| <p> |
| The capacity and maximum capacity for the resulting ProtonBuffer should equal |
| to the length of the wrapped array and the returned array offset is zero.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ProtonBufferAllocator.html#wrap(byte%5B%5D)">wrap</a></code> in interface <code><a href="ProtonBufferAllocator.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferAllocator</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>array</code> - the byte array to wrap.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new ProtonBuffer that wraps the given array.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="wrap(byte[],int,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>wrap</h4> |
| <pre class="methodSignature">public <a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> wrap​(byte[] array, |
| int offset, |
| int length)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ProtonBufferAllocator.html#wrap(byte%5B%5D,int,int)">ProtonBufferAllocator</a></code></span></div> |
| <div class="block">Create a new ProtonBuffer that wraps the given byte array using the provided |
| offset and length values to confine the view of that array. The maximum capacity |
| of the buffer should be that of the length of the wrapped array. |
| <p> |
| The capacity and maximum capacity for the resulting ProtonBuffer should equal |
| to the length of the wrapped array and the returned array offset is zero.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ProtonBufferAllocator.html#wrap(byte%5B%5D,int,int)">wrap</a></code> in interface <code><a href="ProtonBufferAllocator.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferAllocator</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>array</code> - the byte array to wrap.</dd> |
| <dd><code>offset</code> - the offset into the array where the view begins.</dd> |
| <dd><code>length</code> - the number of bytes in the array to expose</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new ProtonBuffer that wraps the given array.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="wrap(java.nio.ByteBuffer)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>wrap</h4> |
| <pre class="methodSignature">public <a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> wrap​(java.nio.ByteBuffer buffer)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="ProtonBufferAllocator.html#wrap(java.nio.ByteBuffer)">ProtonBufferAllocator</a></code></span></div> |
| <div class="block">Create a new ProtonBuffer that wraps the given ByteBuffer. The maximum capacity |
| of the returned buffer should be same as the remaining bytes within the wrapped |
| <code>ByteBuffer</code>. |
| <p> |
| The capacity and maximum capacity of the returned ProtonBuffer will be the |
| same as that of the underlying ByteBuffer. The ProtonBuffer will return true |
| from the <a href="ProtonBuffer.html#hasArray()"><code>ProtonBuffer.hasArray()</code></a> method only when the wrapped ByteBuffer |
| reports that it is backed by an array.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ProtonBufferAllocator.html#wrap(java.nio.ByteBuffer)">wrap</a></code> in interface <code><a href="ProtonBufferAllocator.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBufferAllocator</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>buffer</code> - the <code>ByteBuffer</code> to wrap.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new ProtonBuffer that wraps the given ByteBuffer.</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/ProtonByteBufferAllocator.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> |