blob: 8b638aa5c021d20ae4086d352064a822fdc0bf00 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>FrameWriterBuffer (Qpid Proton-J API)</title>
<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="FrameWriterBuffer (Qpid Proton-J API)";
}
}
catch(err) {
}
//-->
var methods = {"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};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/qpid/proton/engine/impl/FrameHandler.html" title="interface in org.apache.qpid.proton.engine.impl"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/qpid/proton/engine/impl/HandshakeSniffingTransportWrapper.html" title="class in org.apache.qpid.proton.engine.impl"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/qpid/proton/engine/impl/FrameWriterBuffer.html" target="_top">Frames</a></li>
<li><a href="FrameWriterBuffer.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.qpid.proton.engine.impl</div>
<h2 title="Class FrameWriterBuffer" class="title">Class FrameWriterBuffer</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.qpid.proton.engine.impl.FrameWriterBuffer</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html" title="interface in org.apache.qpid.proton.codec">WritableBuffer</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">FrameWriterBuffer</span>
extends java.lang.Object
implements <a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html" title="interface in org.apache.qpid.proton.codec">WritableBuffer</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.qpid.proton.codec.WritableBuffer">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.qpid.proton.codec.<a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html" title="interface in org.apache.qpid.proton.codec">WritableBuffer</a></h3>
<code><a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.ByteBufferWrapper.html" title="class in org.apache.qpid.proton.codec">WritableBuffer.ByteBufferWrapper</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/qpid/proton/engine/impl/FrameWriterBuffer.html#DEFAULT_CAPACITY">DEFAULT_CAPACITY</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/qpid/proton/engine/impl/FrameWriterBuffer.html#FrameWriterBuffer--">FrameWriterBuffer</a></span>()</code>
<div class="block">Creates a new WritableBuffer with default capacity.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/qpid/proton/engine/impl/FrameWriterBuffer.html#FrameWriterBuffer-int-">FrameWriterBuffer</a></span>(int&nbsp;capacity)</code>
<div class="block">Create a new WritableBuffer with the given capacity.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/qpid/proton/engine/impl/FrameWriterBuffer.html#array--">array</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/qpid/proton/engine/impl/FrameWriterBuffer.html#arrayOffset--">arrayOffset</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/qpid/proton/engine/impl/FrameWriterBuffer.html#ensureRemaining-int-">ensureRemaining</a></span>(int&nbsp;requiredRemaining)</code>
<div class="block">Ensures the the buffer has at least the requiredRemaining space specified.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/qpid/proton/engine/impl/FrameWriterBuffer.html#hasRemaining--">hasRemaining</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/qpid/proton/engine/impl/FrameWriterBuffer.html#limit--">limit</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/qpid/proton/engine/impl/FrameWriterBuffer.html#position--">position</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/qpid/proton/engine/impl/FrameWriterBuffer.html#position-int-">position</a></span>(int&nbsp;position)</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/qpid/proton/engine/impl/FrameWriterBuffer.html#put-byte-">put</a></span>(byte&nbsp;b)</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/qpid/proton/engine/impl/FrameWriterBuffer.html#put-byte:A-int-int-">put</a></span>(byte[]&nbsp;src,
int&nbsp;offset,
int&nbsp;length)</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/qpid/proton/engine/impl/FrameWriterBuffer.html#put-java.nio.ByteBuffer-">put</a></span>(java.nio.ByteBuffer&nbsp;payload)</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/qpid/proton/engine/impl/FrameWriterBuffer.html#put-org.apache.qpid.proton.codec.ReadableBuffer-">put</a></span>(<a href="../../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a>&nbsp;payload)</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/qpid/proton/engine/impl/FrameWriterBuffer.html#putDouble-double-">putDouble</a></span>(double&nbsp;value)</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/qpid/proton/engine/impl/FrameWriterBuffer.html#putFloat-float-">putFloat</a></span>(float&nbsp;value)</code>&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/qpid/proton/engine/impl/FrameWriterBuffer.html#putInt-int-">putInt</a></span>(int&nbsp;value)</code>&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/qpid/proton/engine/impl/FrameWriterBuffer.html#putLong-long-">putLong</a></span>(long&nbsp;value)</code>&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/qpid/proton/engine/impl/FrameWriterBuffer.html#putShort-short-">putShort</a></span>(short&nbsp;value)</code>&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/qpid/proton/engine/impl/FrameWriterBuffer.html#remaining--">remaining</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/qpid/proton/engine/impl/FrameWriterBuffer.html#transferTo-java.nio.ByteBuffer-">transferTo</a></span>(java.nio.ByteBuffer&nbsp;target)</code>
<div class="block">Copy bytes from this buffer into the target buffer and compacts this buffer.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.qpid.proton.codec.WritableBuffer">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.qpid.proton.codec.<a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html" title="interface in org.apache.qpid.proton.codec">WritableBuffer</a></h3>
<code><a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html#put-java.lang.String-">put</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="DEFAULT_CAPACITY">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT_CAPACITY</h4>
<pre>public static final&nbsp;int DEFAULT_CAPACITY</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.qpid.proton.engine.impl.FrameWriterBuffer.DEFAULT_CAPACITY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="FrameWriterBuffer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FrameWriterBuffer</h4>
<pre>public&nbsp;FrameWriterBuffer()</pre>
<div class="block">Creates a new WritableBuffer with default capacity.</div>
</li>
</ul>
<a name="FrameWriterBuffer-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FrameWriterBuffer</h4>
<pre>public&nbsp;FrameWriterBuffer(int&nbsp;capacity)</pre>
<div class="block">Create a new WritableBuffer with the given capacity.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>capacity</code> - the inital capacity to allocate for this buffer.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="array--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>array</h4>
<pre>public&nbsp;byte[]&nbsp;array()</pre>
</li>
</ul>
<a name="arrayOffset--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>arrayOffset</h4>
<pre>public&nbsp;int&nbsp;arrayOffset()</pre>
</li>
</ul>
<a name="put-byte-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>put</h4>
<pre>public&nbsp;void&nbsp;put(byte&nbsp;b)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html#put-byte-">put</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html" title="interface in org.apache.qpid.proton.codec">WritableBuffer</a></code></dd>
</dl>
</li>
</ul>
<a name="putShort-short-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>putShort</h4>
<pre>public&nbsp;void&nbsp;putShort(short&nbsp;value)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html#putShort-short-">putShort</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html" title="interface in org.apache.qpid.proton.codec">WritableBuffer</a></code></dd>
</dl>
</li>
</ul>
<a name="putInt-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>putInt</h4>
<pre>public&nbsp;void&nbsp;putInt(int&nbsp;value)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html#putInt-int-">putInt</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html" title="interface in org.apache.qpid.proton.codec">WritableBuffer</a></code></dd>
</dl>
</li>
</ul>
<a name="putLong-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>putLong</h4>
<pre>public&nbsp;void&nbsp;putLong(long&nbsp;value)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html#putLong-long-">putLong</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html" title="interface in org.apache.qpid.proton.codec">WritableBuffer</a></code></dd>
</dl>
</li>
</ul>
<a name="putFloat-float-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>putFloat</h4>
<pre>public&nbsp;void&nbsp;putFloat(float&nbsp;value)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html#putFloat-float-">putFloat</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html" title="interface in org.apache.qpid.proton.codec">WritableBuffer</a></code></dd>
</dl>
</li>
</ul>
<a name="putDouble-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>putDouble</h4>
<pre>public&nbsp;void&nbsp;putDouble(double&nbsp;value)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html#putDouble-double-">putDouble</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html" title="interface in org.apache.qpid.proton.codec">WritableBuffer</a></code></dd>
</dl>
</li>
</ul>
<a name="put-byte:A-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>put</h4>
<pre>public&nbsp;void&nbsp;put(byte[]&nbsp;src,
int&nbsp;offset,
int&nbsp;length)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html#put-byte:A-int-int-">put</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html" title="interface in org.apache.qpid.proton.codec">WritableBuffer</a></code></dd>
</dl>
</li>
</ul>
<a name="put-java.nio.ByteBuffer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>put</h4>
<pre>public&nbsp;void&nbsp;put(java.nio.ByteBuffer&nbsp;payload)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html#put-java.nio.ByteBuffer-">put</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html" title="interface in org.apache.qpid.proton.codec">WritableBuffer</a></code></dd>
</dl>
</li>
</ul>
<a name="put-org.apache.qpid.proton.codec.ReadableBuffer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>put</h4>
<pre>public&nbsp;void&nbsp;put(<a href="../../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a>&nbsp;payload)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html#put-org.apache.qpid.proton.codec.ReadableBuffer-">put</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html" title="interface in org.apache.qpid.proton.codec">WritableBuffer</a></code></dd>
</dl>
</li>
</ul>
<a name="hasRemaining--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasRemaining</h4>
<pre>public&nbsp;boolean&nbsp;hasRemaining()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html#hasRemaining--">hasRemaining</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html" title="interface in org.apache.qpid.proton.codec">WritableBuffer</a></code></dd>
</dl>
</li>
</ul>
<a name="remaining--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remaining</h4>
<pre>public&nbsp;int&nbsp;remaining()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html#remaining--">remaining</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html" title="interface in org.apache.qpid.proton.codec">WritableBuffer</a></code></dd>
</dl>
</li>
</ul>
<a name="ensureRemaining-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ensureRemaining</h4>
<pre>public&nbsp;void&nbsp;ensureRemaining(int&nbsp;requiredRemaining)</pre>
<div class="block">Ensures the the buffer has at least the requiredRemaining space specified.
<p>
The internal buffer will be doubled if the requested capacity is less than that
amount or the buffer will be expanded to the full new requiredRemaining value.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html#ensureRemaining-int-">ensureRemaining</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html" title="interface in org.apache.qpid.proton.codec">WritableBuffer</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>requiredRemaining</code> - the minimum remaining bytes needed to meet the next write operation.</dd>
</dl>
</li>
</ul>
<a name="position--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>position</h4>
<pre>public&nbsp;int&nbsp;position()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html#position--">position</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html" title="interface in org.apache.qpid.proton.codec">WritableBuffer</a></code></dd>
</dl>
</li>
</ul>
<a name="position-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>position</h4>
<pre>public&nbsp;void&nbsp;position(int&nbsp;position)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html#position-int-">position</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html" title="interface in org.apache.qpid.proton.codec">WritableBuffer</a></code></dd>
</dl>
</li>
</ul>
<a name="limit--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>limit</h4>
<pre>public&nbsp;int&nbsp;limit()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html#limit--">limit</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/qpid/proton/codec/WritableBuffer.html" title="interface in org.apache.qpid.proton.codec">WritableBuffer</a></code></dd>
</dl>
</li>
</ul>
<a name="transferTo-java.nio.ByteBuffer-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>transferTo</h4>
<pre>public&nbsp;int&nbsp;transferTo(java.nio.ByteBuffer&nbsp;target)</pre>
<div class="block">Copy bytes from this buffer into the target buffer and compacts this buffer.
<p>
Copy either all bytes written into this buffer (start to current position) or
as many as will fit if the target capacity is less that the bytes written. Bytes
not read from this buffer are moved to the front of the buffer and the position is
reset to the end of the copied region.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>target</code> - The array to move bytes to from those written into this buffer.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of bytes transfered to the target buffer.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/qpid/proton/engine/impl/FrameHandler.html" title="interface in org.apache.qpid.proton.engine.impl"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/qpid/proton/engine/impl/HandshakeSniffingTransportWrapper.html" title="class in org.apache.qpid.proton.engine.impl"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/qpid/proton/engine/impl/FrameWriterBuffer.html" target="_top">Frames</a></li>
<li><a href="FrameWriterBuffer.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>