blob: 585115abd20b74f2f56f580e84dd9d0ec02b3f82 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>ActiveMQBuffers (ActiveMQ Artemis Website 2.33.0 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="ActiveMQBuffers (ActiveMQ Artemis Website 2.33.0 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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="class-use/ActiveMQBuffers.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="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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">&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.activemq.artemis.api.core</a></div>
<h2 title="Class ActiveMQBuffers" class="title">Class ActiveMQBuffers</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.activemq.artemis.api.core.ActiveMQBuffers</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public final class <span class="typeNameLabel">ActiveMQBuffers</span>
extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></pre>
<div class="block">Factory class to create instances of <a href="ActiveMQBuffer.html" title="interface in org.apache.activemq.artemis.api.core"><code>ActiveMQBuffer</code></a>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>static <a href="ActiveMQBuffer.html" title="interface in org.apache.activemq.artemis.api.core">ActiveMQBuffer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dynamicBuffer(byte%5B%5D)">dynamicBuffer</a></span>&#8203;(byte[]&nbsp;bytes)</code></th>
<td class="colLast">
<div class="block">Creates a <em>self-expanding</em> ActiveMQBuffer filled with the given byte array</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="ActiveMQBuffer.html" title="interface in org.apache.activemq.artemis.api.core">ActiveMQBuffer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dynamicBuffer(int)">dynamicBuffer</a></span>&#8203;(int&nbsp;size)</code></th>
<td class="colLast">
<div class="block">Creates a <em>self-expanding</em> ActiveMQBuffer with the given initial size</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="ActiveMQBuffer.html" title="interface in org.apache.activemq.artemis.api.core">ActiveMQBuffer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fixedBuffer(int)">fixedBuffer</a></span>&#8203;(int&nbsp;size)</code></th>
<td class="colLast">
<div class="block">Creates a <em>fixed</em> ActiveMQBuffer of the given size</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="ActiveMQBuffer.html" title="interface in org.apache.activemq.artemis.api.core">ActiveMQBuffer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#pooledBuffer(int)">pooledBuffer</a></span>&#8203;(int&nbsp;size)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href="ActiveMQBuffer.html" title="interface in org.apache.activemq.artemis.api.core">ActiveMQBuffer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#wrappedBuffer(byte%5B%5D)">wrappedBuffer</a></span>&#8203;(byte[]&nbsp;underlying)</code></th>
<td class="colLast">
<div class="block">Creates an ActiveMQBuffer wrapping an underlying byte array</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static <a href="ActiveMQBuffer.html" title="interface in org.apache.activemq.artemis.api.core">ActiveMQBuffer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#wrappedBuffer(io.netty.buffer.ByteBuf)">wrappedBuffer</a></span>&#8203;(io.netty.buffer.ByteBuf&nbsp;underlying)</code></th>
<td class="colLast">
<div class="block">Creates an ActiveMQBuffer wrapping an underlying ByteBuf
The position on this buffer won't affect the position on the inner buffer</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static <a href="ActiveMQBuffer.html" title="interface in org.apache.activemq.artemis.api.core">ActiveMQBuffer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#wrappedBuffer(java.nio.ByteBuffer)">wrappedBuffer</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio" class="externalLink">ByteBuffer</a>&nbsp;underlying)</code></th>
<td class="colLast">
<div class="block">Creates an ActiveMQBuffer wrapping an underlying NIO ByteBuffer
The position on this buffer won't affect the position on the inner buffer</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&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="dynamicBuffer(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dynamicBuffer</h4>
<pre class="methodSignature">public static&nbsp;<a href="ActiveMQBuffer.html" title="interface in org.apache.activemq.artemis.api.core">ActiveMQBuffer</a>&nbsp;dynamicBuffer&#8203;(int&nbsp;size)</pre>
<div class="block">Creates a <em>self-expanding</em> ActiveMQBuffer with the given initial size</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>size</code> - the initial size of the created ActiveMQBuffer</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a self-expanding ActiveMQBuffer starting with the given size</dd>
</dl>
</li>
</ul>
<a id="pooledBuffer(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pooledBuffer</h4>
<pre class="methodSignature">public static&nbsp;<a href="ActiveMQBuffer.html" title="interface in org.apache.activemq.artemis.api.core">ActiveMQBuffer</a>&nbsp;pooledBuffer&#8203;(int&nbsp;size)</pre>
</li>
</ul>
<a id="dynamicBuffer(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dynamicBuffer</h4>
<pre class="methodSignature">public static&nbsp;<a href="ActiveMQBuffer.html" title="interface in org.apache.activemq.artemis.api.core">ActiveMQBuffer</a>&nbsp;dynamicBuffer&#8203;(byte[]&nbsp;bytes)</pre>
<div class="block">Creates a <em>self-expanding</em> ActiveMQBuffer filled with the given byte array</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>bytes</code> - the created buffer will be initially filled with this byte array</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a self-expanding ActiveMQBuffer filled with the given byte array</dd>
</dl>
</li>
</ul>
<a id="wrappedBuffer(java.nio.ByteBuffer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>wrappedBuffer</h4>
<pre class="methodSignature">public static&nbsp;<a href="ActiveMQBuffer.html" title="interface in org.apache.activemq.artemis.api.core">ActiveMQBuffer</a>&nbsp;wrappedBuffer&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio" class="externalLink">ByteBuffer</a>&nbsp;underlying)</pre>
<div class="block">Creates an ActiveMQBuffer wrapping an underlying NIO ByteBuffer
The position on this buffer won't affect the position on the inner buffer</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>underlying</code> - the underlying NIO ByteBuffer</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an ActiveMQBuffer wrapping the underlying NIO ByteBuffer</dd>
</dl>
</li>
</ul>
<a id="wrappedBuffer(io.netty.buffer.ByteBuf)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>wrappedBuffer</h4>
<pre class="methodSignature">public static&nbsp;<a href="ActiveMQBuffer.html" title="interface in org.apache.activemq.artemis.api.core">ActiveMQBuffer</a>&nbsp;wrappedBuffer&#8203;(io.netty.buffer.ByteBuf&nbsp;underlying)</pre>
<div class="block">Creates an ActiveMQBuffer wrapping an underlying ByteBuf
The position on this buffer won't affect the position on the inner buffer</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>underlying</code> - the underlying NIO ByteBuffer</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an ActiveMQBuffer wrapping the underlying NIO ByteBuffer</dd>
</dl>
</li>
</ul>
<a id="wrappedBuffer(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>wrappedBuffer</h4>
<pre class="methodSignature">public static&nbsp;<a href="ActiveMQBuffer.html" title="interface in org.apache.activemq.artemis.api.core">ActiveMQBuffer</a>&nbsp;wrappedBuffer&#8203;(byte[]&nbsp;underlying)</pre>
<div class="block">Creates an ActiveMQBuffer wrapping an underlying byte array</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>underlying</code> - the underlying byte array</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an ActiveMQBuffer wrapping the underlying byte array</dd>
</dl>
</li>
</ul>
<a id="fixedBuffer(int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>fixedBuffer</h4>
<pre class="methodSignature">public static&nbsp;<a href="ActiveMQBuffer.html" title="interface in org.apache.activemq.artemis.api.core">ActiveMQBuffer</a>&nbsp;fixedBuffer&#8203;(int&nbsp;size)</pre>
<div class="block">Creates a <em>fixed</em> ActiveMQBuffer of the given size</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>size</code> - the size of the created ActiveMQBuffer</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a fixed ActiveMQBuffer with the given size</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/ActiveMQBuffers.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="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &#169; 2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>