http://git-wip-us.apache.org/repos/asf/qpid-site/blob/f6f494e6/content/releases/qpid-proton-j-0.28.0/api/org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-j-0.28.0/api/org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html b/content/releases/qpid-proton-j-0.28.0/api/org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html new file mode 100755 index 0000000..7a1aa3b --- /dev/null +++ b/content/releases/qpid-proton-j-0.28.0/api/org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html @@ -0,0 +1,1130 @@ +<!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>ReadableBuffer.ByteBufferReader (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="ReadableBuffer.ByteBufferReader (Qpid Proton-J API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":9,"i36":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/qpid/proton/codec/ShortType.html" title="class in org.apache.qpid.proton.codec"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html" target="_top">Frames</a></li> +<li><a href="ReadableBuffer.ByteBufferReader.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.qpid.proton.codec</div> +<h2 title="Class ReadableBuffer.ByteBufferReader" class="title">Class ReadableBuffer.ByteBufferReader</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.qpid.proton.codec.ReadableBuffer.ByteBufferReader</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/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></dd> +</dl> +<dl> +<dt>Enclosing interface:</dt> +<dd><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></dd> +</dl> +<hr> +<br> +<pre>public static final class <span class="typeNameLabel">ReadableBuffer.ByteBufferReader</span> +extends java.lang.Object +implements <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</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.ReadableBuffer"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface org.apache.qpid.proton.codec.<a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></h3> +<code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html" title="class in org.apache.qpid.proton.codec">ReadableBuffer.ByteBufferReader</a></code></li> +</ul> +</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"> </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/codec/ReadableBuffer.ByteBufferReader.html#ByteBufferReader-java.nio.ByteBuffer-">ByteBufferReader</a></span>(java.nio.ByteBuffer buffer)</code> </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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html" title="class in org.apache.qpid.proton.codec">ReadableBuffer.ByteBufferReader</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html#allocate-int-">allocate</a></span>(int size)</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html#array--">array</a></span>()</code> +<div class="block">Returns the primitive array that backs this buffer if one exists and the + buffer is not read-only.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html#arrayOffset--">arrayOffset</a></span>()</code> +<div class="block">Returns the offset into the backing array of the first element in the buffer.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>java.nio.ByteBuffer</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html#byteBuffer--">byteBuffer</a></span>()</code> </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/codec/ReadableBuffer.ByteBufferReader.html#capacity--">capacity</a></span>()</code> +<div class="block">Returns the capacity of the backing buffer of this ReadableBuffer</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html#clear--">clear</a></span>()</code> +<div class="block">Resets the buffer position to zero and sets the limit to the buffer capacity, + the mark value is discarded if set.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html#duplicate--">duplicate</a></span>()</code> +<div class="block">Creates a duplicate <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec"><code>ReadableBuffer</code></a> to this instance.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object other)</code> </td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html#flip--">flip</a></span>()</code> +<div class="block">Sets the buffer limit to the current position and the position is set to zero, the + mark value reset to undefined.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>byte</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html#get--">get</a></span>()</code> +<div class="block">Reads the byte at the current position and advances the position by 1.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html#get-byte:A-">get</a></span>(byte[] data)</code> +<div class="block">A bulk read method that copies bytes from this buffer into the target byte array.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html#get-byte:A-int-int-">get</a></span>(byte[] data, + int offset, + int length)</code> +<div class="block">A bulk read method that copies bytes from this buffer into the target byte array.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>byte</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html#get-int-">get</a></span>(int index)</code> +<div class="block">Reads the byte at the given index, the buffer position is not affected.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html#get-org.apache.qpid.proton.codec.WritableBuffer-">get</a></span>(<a href="../../../../../org/apache/qpid/proton/codec/WritableBuffer.html" title="interface in org.apache.qpid.proton.codec">WritableBuffer</a> target)</code> +<div class="block">Copy data from this buffer to the target buffer starting from the current + position and continuing until either this buffer's remaining bytes are + consumed or the target is full.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html#getDouble--">getDouble</a></span>()</code> +<div class="block">Reads eight bytes from the buffer and returns them as an double value.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code>float</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html#getFloat--">getFloat</a></span>()</code> +<div class="block">Reads four bytes from the buffer and returns them as an float value.</div> +</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/codec/ReadableBuffer.ByteBufferReader.html#getInt--">getInt</a></span>()</code> +<div class="block">Reads four bytes from the buffer and returns them as an integer value.</div> +</td> +</tr> +<tr id="i17" class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html#getLong--">getLong</a></span>()</code> +<div class="block">Reads eight bytes from the buffer and returns them as an long value.</div> +</td> +</tr> +<tr id="i18" class="altColor"> +<td class="colFirst"><code>short</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html#getShort--">getShort</a></span>()</code> +<div class="block">Reads two bytes from the buffer and returns them as an short value.</div> +</td> +</tr> +<tr id="i19" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html#hasArray--">hasArray</a></span>()</code> +<div class="block">Returns true if this ReadableBuffer is backed by an array which can be + accessed by the <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#array--"><code>ReadableBuffer.array()</code></a> and <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#arrayOffset--"><code>ReadableBuffer.arrayOffset()</code></a> methods.</div> +</td> +</tr> +<tr id="i20" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html#hashCode--">hashCode</a></span>()</code> </td> +</tr> +<tr id="i21" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html#hasRemaining--">hasRemaining</a></span>()</code> </td> +</tr> +<tr id="i22" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html#limit--">limit</a></span>()</code> </td> +</tr> +<tr id="i23" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html#limit-int-">limit</a></span>(int limit)</code> +<div class="block">Sets the current read limit of this buffer to the given value.</div> +</td> +</tr> +<tr id="i24" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html#mark--">mark</a></span>()</code> +<div class="block">Mark the current position of this buffer which can be returned to after a + read operation by calling <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#reset--"><code>ReadableBuffer.reset()</code></a>.</div> +</td> +</tr> +<tr id="i25" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html#position--">position</a></span>()</code> </td> +</tr> +<tr id="i26" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html#position-int-">position</a></span>(int position)</code> +<div class="block">Sets the current position of this buffer to the given value.</div> +</td> +</tr> +<tr id="i27" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html#readString-java.nio.charset.CharsetDecoder-">readString</a></span>(java.nio.charset.CharsetDecoder decoder)</code> +<div class="block">Decodes a String from the buffer using the provided <code>CharsetDecoder</code> + starting the decode at the current position and reading until the limit is + reached.</div> +</td> +</tr> +<tr id="i28" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html#readUTF8--">readUTF8</a></span>()</code> +<div class="block">Reads a UTF-8 encoded String from the buffer starting the decode at the + current position and reading until the limit is reached.</div> +</td> +</tr> +<tr id="i29" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html#reclaimRead--">reclaimRead</a></span>()</code> +<div class="block">Compact the backing storage of this ReadableBuffer, possibly freeing previously-read + portions of pooled data or reducing the number of backing arrays if present.</div> +</td> +</tr> +<tr id="i30" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html#remaining--">remaining</a></span>()</code> </td> +</tr> +<tr id="i31" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html#reset--">reset</a></span>()</code> +<div class="block">Reset the buffer's position to a previously marked value, the mark should remain + set after calling this method.</div> +</td> +</tr> +<tr id="i32" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html#rewind--">rewind</a></span>()</code> +<div class="block">Resets the buffer position to zero and clears and previously set mark.</div> +</td> +</tr> +<tr id="i33" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html#slice--">slice</a></span>()</code> +<div class="block">Creates a new ReadableBuffer instance that is a view of the readable portion of + this buffer.</div> +</td> +</tr> +<tr id="i34" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html#toString--">toString</a></span>()</code> </td> +</tr> +<tr id="i35" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html" title="class in org.apache.qpid.proton.codec">ReadableBuffer.ByteBufferReader</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html#wrap-byte:A-">wrap</a></span>(byte[] array)</code> </td> +</tr> +<tr id="i36" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html" title="class in org.apache.qpid.proton.codec">ReadableBuffer.ByteBufferReader</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html#wrap-java.nio.ByteBuffer-">wrap</a></span>(java.nio.ByteBuffer buffer)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ByteBufferReader-java.nio.ByteBuffer-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ByteBufferReader</h4> +<pre>public ByteBufferReader(java.nio.ByteBuffer buffer)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="allocate-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>allocate</h4> +<pre>public static <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html" title="class in org.apache.qpid.proton.codec">ReadableBuffer.ByteBufferReader</a> allocate(int size)</pre> +</li> +</ul> +<a name="wrap-java.nio.ByteBuffer-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>wrap</h4> +<pre>public static <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html" title="class in org.apache.qpid.proton.codec">ReadableBuffer.ByteBufferReader</a> wrap(java.nio.ByteBuffer buffer)</pre> +</li> +</ul> +<a name="wrap-byte:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>wrap</h4> +<pre>public static <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html" title="class in org.apache.qpid.proton.codec">ReadableBuffer.ByteBufferReader</a> wrap(byte[] array)</pre> +</li> +</ul> +<a name="capacity--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>capacity</h4> +<pre>public int capacity()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#capacity--">ReadableBuffer</a></code></span></div> +<div class="block">Returns the capacity of the backing buffer of this ReadableBuffer</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#capacity--">capacity</a></code> in interface <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the capacity of the backing buffer of this ReadableBuffer</dd> +</dl> +</li> +</ul> +<a name="get--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public byte get()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#get--">ReadableBuffer</a></code></span></div> +<div class="block">Reads the byte at the current position and advances the position by 1.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#get--">get</a></code> in interface <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the byte at the current position.</dd> +</dl> +</li> +</ul> +<a name="get-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public byte get(int index)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#get-int-">ReadableBuffer</a></code></span></div> +<div class="block">Reads the byte at the given index, the buffer position is not affected.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#get-int-">get</a></code> in interface <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>index</code> - The index in the buffer from which to read the byte.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the byte value stored at the target index.</dd> +</dl> +</li> +</ul> +<a name="getInt--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInt</h4> +<pre>public int getInt()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#getInt--">ReadableBuffer</a></code></span></div> +<div class="block">Reads four bytes from the buffer and returns them as an integer value. The + buffer position is advanced by four byes.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#getInt--">getInt</a></code> in interface <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>and integer value composed of bytes read from the buffer.</dd> +</dl> +</li> +</ul> +<a name="getLong--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLong</h4> +<pre>public long getLong()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#getLong--">ReadableBuffer</a></code></span></div> +<div class="block">Reads eight bytes from the buffer and returns them as an long value. The + buffer position is advanced by eight byes.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#getLong--">getLong</a></code> in interface <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>and long value composed of bytes read from the buffer.</dd> +</dl> +</li> +</ul> +<a name="getShort--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getShort</h4> +<pre>public short getShort()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#getShort--">ReadableBuffer</a></code></span></div> +<div class="block">Reads two bytes from the buffer and returns them as an short value. The + buffer position is advanced by two byes.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#getShort--">getShort</a></code> in interface <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>and short value composed of bytes read from the buffer.</dd> +</dl> +</li> +</ul> +<a name="getFloat--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFloat</h4> +<pre>public float getFloat()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#getFloat--">ReadableBuffer</a></code></span></div> +<div class="block">Reads four bytes from the buffer and returns them as an float value. The + buffer position is advanced by four byes.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#getFloat--">getFloat</a></code> in interface <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>and float value composed of bytes read from the buffer.</dd> +</dl> +</li> +</ul> +<a name="getDouble--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDouble</h4> +<pre>public double getDouble()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#getDouble--">ReadableBuffer</a></code></span></div> +<div class="block">Reads eight bytes from the buffer and returns them as an double value. The + buffer position is advanced by eight byes.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#getDouble--">getDouble</a></code> in interface <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>and double value composed of bytes read from the buffer.</dd> +</dl> +</li> +</ul> +<a name="limit--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>limit</h4> +<pre>public int limit()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#limit--">limit</a></code> in interface <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the current value of this buffer's limit.</dd> +</dl> +</li> +</ul> +<a name="get-byte:A-int-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a> get(byte[] data, + int offset, + int length)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#get-byte:A-int-int-">ReadableBuffer</a></code></span></div> +<div class="block">A bulk read method that copies bytes from this buffer into the target byte array.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#get-byte:A-int-int-">get</a></code> in interface <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>data</code> - The byte array to copy bytes read from this buffer.</dd> +<dd><code>offset</code> - The offset into the given array where the copy starts.</dd> +<dd><code>length</code> - The number of bytes to copy into the target array.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a reference to this ReadableBuffer instance.</dd> +</dl> +</li> +</ul> +<a name="get-byte:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a> get(byte[] data)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#get-byte:A-">ReadableBuffer</a></code></span></div> +<div class="block">A bulk read method that copies bytes from this buffer into the target byte array.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#get-byte:A-">get</a></code> in interface <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>data</code> - The byte array to copy bytes read from this buffer.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a reference to this ReadableBuffer instance.</dd> +</dl> +</li> +</ul> +<a name="flip--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>flip</h4> +<pre>public <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a> flip()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#flip--">ReadableBuffer</a></code></span></div> +<div class="block">Sets the buffer limit to the current position and the position is set to zero, the + mark value reset to undefined.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#flip--">flip</a></code> in interface <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a reference to this <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec"><code>ReadableBuffer</code></a>.</dd> +</dl> +</li> +</ul> +<a name="position-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>position</h4> +<pre>public <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a> position(int position)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#position-int-">ReadableBuffer</a></code></span></div> +<div class="block">Sets the current position of this buffer to the given value. If the buffer mark + value is defined and is larger than the newly set position is must be discarded.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#position-int-">position</a></code> in interface <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>position</code> - The new position to set for this buffer.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a reference to this <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec"><code>ReadableBuffer</code></a>.</dd> +</dl> +</li> +</ul> +<a name="slice--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>slice</h4> +<pre>public <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a> slice()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#slice--">ReadableBuffer</a></code></span></div> +<div class="block">Creates a new ReadableBuffer instance that is a view of the readable portion of + this buffer. The position will be set to zero and the limit and the reported capacity + will match the value returned by this buffer's <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#remaining--"><code>ReadableBuffer.remaining()</code></a> method, the mark + will be undefined.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#slice--">slice</a></code> in interface <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a new ReadableBuffer that is a view of the readable portion of this buffer.</dd> +</dl> +</li> +</ul> +<a name="limit-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>limit</h4> +<pre>public <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a> limit(int limit)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#limit-int-">ReadableBuffer</a></code></span></div> +<div class="block">Sets the current read limit of this buffer to the given value. If the buffer mark + value is defined and is larger than the limit the mark will be discarded. If the + position is larger than the new limit it will be reset to the new limit.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#limit-int-">limit</a></code> in interface <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>limit</code> - The new read limit to set for this buffer.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a reference to this <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec"><code>ReadableBuffer</code></a>.</dd> +</dl> +</li> +</ul> +<a name="remaining--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>remaining</h4> +<pre>public int remaining()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#remaining--">remaining</a></code> in interface <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the remaining number of readable bytes in this buffer.</dd> +</dl> +</li> +</ul> +<a name="position--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>position</h4> +<pre>public int position()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#position--">position</a></code> in interface <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the current position from which the next read operation will start.</dd> +</dl> +</li> +</ul> +<a name="hasRemaining--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasRemaining</h4> +<pre>public boolean hasRemaining()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#hasRemaining--">hasRemaining</a></code> in interface <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if there are readable bytes still remaining in this buffer.</dd> +</dl> +</li> +</ul> +<a name="duplicate--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>duplicate</h4> +<pre>public <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a> duplicate()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#duplicate--">ReadableBuffer</a></code></span></div> +<div class="block">Creates a duplicate <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec"><code>ReadableBuffer</code></a> to this instance. + <p> + The duplicated buffer will have the same position, limit and mark as this + buffer. The two buffers share the same backing data.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#duplicate--">duplicate</a></code> in interface <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a duplicate of this <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec"><code>ReadableBuffer</code></a>.</dd> +</dl> +</li> +</ul> +<a name="byteBuffer--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>byteBuffer</h4> +<pre>public java.nio.ByteBuffer byteBuffer()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#byteBuffer--">byteBuffer</a></code> in interface <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a ByteBuffer view of the current readable portion of this buffer.</dd> +</dl> +</li> +</ul> +<a name="readUTF8--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readUTF8</h4> +<pre>public java.lang.String readUTF8()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#readUTF8--">ReadableBuffer</a></code></span></div> +<div class="block">Reads a UTF-8 encoded String from the buffer starting the decode at the + current position and reading until the limit is reached. The position + is advanced to the limit once this method returns. If there is no bytes + remaining in the buffer when this method is called a null is returned.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#readUTF8--">readUTF8</a></code> in interface <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a string decoded from the remaining bytes in this buffer.</dd> +</dl> +</li> +</ul> +<a name="readString-java.nio.charset.CharsetDecoder-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readString</h4> +<pre>public java.lang.String readString(java.nio.charset.CharsetDecoder decoder) + throws java.nio.charset.CharacterCodingException</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#readString-java.nio.charset.CharsetDecoder-">ReadableBuffer</a></code></span></div> +<div class="block">Decodes a String from the buffer using the provided <code>CharsetDecoder</code> + starting the decode at the current position and reading until the limit is + reached. The position is advanced to the limit once this method returns. + If there is no bytes remaining in the buffer when this method is called a + null is returned.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#readString-java.nio.charset.CharsetDecoder-">readString</a></code> in interface <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a string decoded from the remaining bytes in this buffer.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.nio.charset.CharacterCodingException</code> - if the encoding is invalid for any reason.</dd> +</dl> +</li> +</ul> +<a name="hasArray--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasArray</h4> +<pre>public boolean hasArray()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#hasArray--">ReadableBuffer</a></code></span></div> +<div class="block">Returns true if this ReadableBuffer is backed by an array which can be + accessed by the <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#array--"><code>ReadableBuffer.array()</code></a> and <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#arrayOffset--"><code>ReadableBuffer.arrayOffset()</code></a> methods.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#hasArray--">hasArray</a></code> in interface <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if the buffer is backed by a primitive array.</dd> +</dl> +</li> +</ul> +<a name="array--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>array</h4> +<pre>public byte[] array()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#array--">ReadableBuffer</a></code></span></div> +<div class="block">Returns the primitive array that backs this buffer if one exists and the + buffer is not read-only. The caller should have checked the <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#hasArray--"><code>ReadableBuffer.hasArray()</code></a> + method before calling this method.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#array--">array</a></code> in interface <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the array that backs this buffer is available.</dd> +</dl> +</li> +</ul> +<a name="arrayOffset--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>arrayOffset</h4> +<pre>public int arrayOffset()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#arrayOffset--">ReadableBuffer</a></code></span></div> +<div class="block">Returns the offset into the backing array of the first element in the buffer. The caller + should have checked the <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#hasArray--"><code>ReadableBuffer.hasArray()</code></a> method before calling this method.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#arrayOffset--">arrayOffset</a></code> in interface <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the offset into the backing array of the first element in the buffer.</dd> +</dl> +</li> +</ul> +<a name="reclaimRead--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reclaimRead</h4> +<pre>public <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a> reclaimRead()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#reclaimRead--">ReadableBuffer</a></code></span></div> +<div class="block">Compact the backing storage of this ReadableBuffer, possibly freeing previously-read + portions of pooled data or reducing the number of backing arrays if present. + <p> + This is an optional operation and care should be taken in its implementation.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#reclaimRead--">reclaimRead</a></code> in interface <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a reference to this buffer</dd> +</dl> +</li> +</ul> +<a name="mark--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>mark</h4> +<pre>public <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a> mark()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#mark--">ReadableBuffer</a></code></span></div> +<div class="block">Mark the current position of this buffer which can be returned to after a + read operation by calling <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#reset--"><code>ReadableBuffer.reset()</code></a>.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#mark--">mark</a></code> in interface <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a reference to this <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec"><code>ReadableBuffer</code></a>.</dd> +</dl> +</li> +</ul> +<a name="reset--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reset</h4> +<pre>public <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a> reset()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#reset--">ReadableBuffer</a></code></span></div> +<div class="block">Reset the buffer's position to a previously marked value, the mark should remain + set after calling this method.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#reset--">reset</a></code> in interface <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a reference to this <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec"><code>ReadableBuffer</code></a>.</dd> +</dl> +</li> +</ul> +<a name="rewind--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>rewind</h4> +<pre>public <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a> rewind()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#rewind--">ReadableBuffer</a></code></span></div> +<div class="block">Resets the buffer position to zero and clears and previously set mark.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#rewind--">rewind</a></code> in interface <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a reference to this <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec"><code>ReadableBuffer</code></a>.</dd> +</dl> +</li> +</ul> +<a name="clear--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clear</h4> +<pre>public <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a> clear()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#clear--">ReadableBuffer</a></code></span></div> +<div class="block">Resets the buffer position to zero and sets the limit to the buffer capacity, + the mark value is discarded if set.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#clear--">clear</a></code> in interface <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a reference to this <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec"><code>ReadableBuffer</code></a>.</dd> +</dl> +</li> +</ul> +<a name="get-org.apache.qpid.proton.codec.WritableBuffer-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a> get(<a href="../../../../../org/apache/qpid/proton/codec/WritableBuffer.html" title="interface in org.apache.qpid.proton.codec">WritableBuffer</a> target)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#get-org.apache.qpid.proton.codec.WritableBuffer-">ReadableBuffer</a></code></span></div> +<div class="block">Copy data from this buffer to the target buffer starting from the current + position and continuing until either this buffer's remaining bytes are + consumed or the target is full.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html#get-org.apache.qpid.proton.codec.WritableBuffer-">get</a></code> in interface <code><a href="../../../../../org/apache/qpid/proton/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec">ReadableBuffer</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>target</code> - The WritableBuffer to transfer this buffer's data to.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a reference to this ReadableBuffer instance.</dd> +</dl> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="hashCode--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="equals-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object other)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +</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/codec/ReadableBuffer.html" title="interface in org.apache.qpid.proton.codec"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/qpid/proton/codec/ShortType.html" title="class in org.apache.qpid.proton.codec"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/qpid/proton/codec/ReadableBuffer.ByteBufferReader.html" target="_top">Frames</a></li> +<li><a href="ReadableBuffer.ByteBufferReader.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.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> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
--------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@qpid.apache.org For additional commands, e-mail: commits-h...@qpid.apache.org