| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ProtonBufferAccessors (Qpid ProtonJ2 Parent 1.0.0-M18 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.qpid.protonj2.buffer, interface: ProtonBufferAccessors"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/ProtonBufferAccessors.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.qpid.protonj2.buffer</a></div> |
| <h1 title="Interface ProtonBufferAccessors" class="title">Interface ProtonBufferAccessors</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code>, <code><a href="ProtonCompositeBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonCompositeBuffer</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="netty/Netty4ToProtonBufferAdapter.html" title="class in org.apache.qpid.protonj2.buffer.netty">Netty4ToProtonBufferAdapter</a></code>, <code><a href="netty/Netty5ToProtonBufferAdapter.html" title="class in org.apache.qpid.protonj2.buffer.netty">Netty5ToProtonBufferAdapter</a></code>, <code><a href="impl/ProtonByteArrayBuffer.html" title="class in org.apache.qpid.protonj2.buffer.impl">ProtonByteArrayBuffer</a></code>, <code><a href="impl/ProtonCompositeBufferImpl.html" title="class in org.apache.qpid.protonj2.buffer.impl">ProtonCompositeBufferImpl</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ProtonBufferAccessors</span></div> |
| <div class="block">Interface for any buffer access implementation which provides consistent read |
| and write APIs for primitive values. These APIs are useful for serialization |
| and de-serialization APIs which need to write at a primitive level.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getBoolean(int)" class="member-name-link">getBoolean</a><wbr>(int index)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Reads a single byte at the given index and returns it as a boolean value, |
| without modification to the target buffer read offset.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>byte</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getByte(int)" class="member-name-link">getByte</a><wbr>(int index)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Reads a single byte at the given index and returns it without modification to the target |
| buffer read offset.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>char</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getChar(int)" class="member-name-link">getChar</a><wbr>(int index)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets a 2-byte char from the specified index, this method will not modify the read or write |
| index.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default double</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getDouble(int)" class="member-name-link">getDouble</a><wbr>(int index)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Gets a double from the specified index, this method will not modify the read or write |
| index.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default float</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getFloat(int)" class="member-name-link">getFloat</a><wbr>(int index)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Gets a float from the specified index, this method will not modify the read or write |
| index.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getInt(int)" class="member-name-link">getInt</a><wbr>(int index)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets a int from the specified index, this method will not modify the read or write |
| index.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getLong(int)" class="member-name-link">getLong</a><wbr>(int index)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets a long from the specified index, this method will not modify the read or write |
| index.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>short</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getShort(int)" class="member-name-link">getShort</a><wbr>(int index)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets a short from the specified index, this method will not modify the read or write |
| index.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getUnsignedByte(int)" class="member-name-link">getUnsignedByte</a><wbr>(int index)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Gets a unsigned byte from the specified index, this method will not modify the read or write |
| index.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getUnsignedInt(int)" class="member-name-link">getUnsignedInt</a><wbr>(int index)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Gets a unsigned int from the specified index, this method will not modify the read or write |
| index.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getUnsignedShort(int)" class="member-name-link">getUnsignedShort</a><wbr>(int index)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Gets a unsigned short from the specified index, this method will not modify the read or write |
| index.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#readBoolean()" class="member-name-link">readBoolean</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Reads a boolean value from the buffer and advances the read index by one.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>byte</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#readByte()" class="member-name-link">readByte</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Reads one byte from the buffer and advances the read index by one.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>char</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#readChar()" class="member-name-link">readChar</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Reads a character value from the buffer and advances the read index by four.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default double</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#readDouble()" class="member-name-link">readDouble</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Reads a double value from the buffer and advances the read index by eight.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default float</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#readFloat()" class="member-name-link">readFloat</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Reads a float value from the buffer and advances the read index by four.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#readInt()" class="member-name-link">readInt</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Reads a integer value from the buffer and advances the read index by four.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#readLong()" class="member-name-link">readLong</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Reads a long value from the buffer and advances the read index by eight.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>short</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#readShort()" class="member-name-link">readShort</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Reads a short value from the buffer and advances the read index by two.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#readUnsignedByte()" class="member-name-link">readUnsignedByte</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Reads one byte from the buffer and advances the read index by one.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#readUnsignedInt()" class="member-name-link">readUnsignedInt</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Reads a unsigned integer value from the buffer and advances the read index by four.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#readUnsignedShort()" class="member-name-link">readUnsignedShort</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Reads an integer value from the buffer that represent the unsigned value of the short and |
| advances the read index by two.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#setBoolean(int,boolean)" class="member-name-link">setBoolean</a><wbr>(int index, |
| boolean value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Sets the boolean value at the given write index in this buffer's backing data store.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setByte(int,byte)" class="member-name-link">setByte</a><wbr>(int index, |
| byte value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the byte value at the given write index in this buffer's backing data store.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setChar(int,char)" class="member-name-link">setChar</a><wbr>(int index, |
| char value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the char value at the given write index in this buffer's backing data store.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#setDouble(int,double)" class="member-name-link">setDouble</a><wbr>(int index, |
| double value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Sets the double value at the given write index in this buffer's backing data store.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#setFloat(int,float)" class="member-name-link">setFloat</a><wbr>(int index, |
| float value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Sets the float value at the given write index in this buffer's backing data store.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setInt(int,int)" class="member-name-link">setInt</a><wbr>(int index, |
| int value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the int value at the given write index in this buffer's backing data store.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setLong(int,long)" class="member-name-link">setLong</a><wbr>(int index, |
| long value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the long value at the given write index in this buffer's backing data store.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setShort(int,short)" class="member-name-link">setShort</a><wbr>(int index, |
| short value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets the short value at the given write index in this buffer's backing data store.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#setUnsignedByte(int,int)" class="member-name-link">setUnsignedByte</a><wbr>(int index, |
| int value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Sets the unsigned byte value at the given write index in this buffer's backing data store.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#setUnsignedInt(int,long)" class="member-name-link">setUnsignedInt</a><wbr>(int index, |
| long value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Sets the long value at the given write index in this buffer's backing data store.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#setUnsignedShort(int,int)" class="member-name-link">setUnsignedShort</a><wbr>(int index, |
| int value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Sets the short value at the given write index in this buffer's backing data store.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#writeBoolean(boolean)" class="member-name-link">writeBoolean</a><wbr>(boolean value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Writes a single boolean to the buffer and advances the write index by one.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#writeByte(byte)" class="member-name-link">writeByte</a><wbr>(byte value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Writes a single byte to the buffer and advances the write index by one.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#writeChar(char)" class="member-name-link">writeChar</a><wbr>(char value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Writes a single character to the buffer and advances the write index by four.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#writeDouble(double)" class="member-name-link">writeDouble</a><wbr>(double value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Writes a single double to the buffer and advances the write index by eight.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#writeFloat(float)" class="member-name-link">writeFloat</a><wbr>(float value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Writes a single float to the buffer and advances the write index by four.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#writeInt(int)" class="member-name-link">writeInt</a><wbr>(int value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Writes a single integer to the buffer and advances the write index by four.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#writeLong(long)" class="member-name-link">writeLong</a><wbr>(long value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Writes a single long to the buffer and advances the write index by eight.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#writeShort(short)" class="member-name-link">writeShort</a><wbr>(short value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Writes a single short to the buffer and advances the write index by two.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#writeUnsignedByte(int)" class="member-name-link">writeUnsignedByte</a><wbr>(int value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Writes a single byte to the buffer and advances the write index by one.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#writeUnsignedInt(long)" class="member-name-link">writeUnsignedInt</a><wbr>(long value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Writes a single unsigned int to the buffer and advances the write index by four.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#writeUnsignedShort(int)" class="member-name-link">writeUnsignedShort</a><wbr>(int value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Writes a single short to the buffer using the input integer value and advances the write index by two.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getByte(int)"> |
| <h3>getByte</h3> |
| <div class="member-signature"><span class="return-type">byte</span> <span class="element-name">getByte</span><wbr><span class="parameters">(int index)</span></div> |
| <div class="block">Reads a single byte at the given index and returns it without modification to the target |
| buffer read offset.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - The index into the buffer where the value should be read.</dd> |
| <dt>Returns:</dt> |
| <dd>the value read from the given index.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if the index is negative or past the current buffer capacity.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setByte(int,byte)"> |
| <h3>setByte</h3> |
| <div class="member-signature"><span class="return-type"><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></span> <span class="element-name">setByte</span><wbr><span class="parameters">(int index, |
| byte value)</span></div> |
| <div class="block">Sets the byte value at the given write index in this buffer's backing data store.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - The index to start the write from.</dd> |
| <dd><code>value</code> - The value to write at the given index.</dd> |
| <dt>Returns:</dt> |
| <dd>a reference to this ProtonBuffer for chaining.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if the index is negative or the write would exceed capacity.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readByte()"> |
| <h3>readByte</h3> |
| <div class="member-signature"><span class="return-type">byte</span> <span class="element-name">readByte</span>()</div> |
| <div class="block">Reads one byte from the buffer and advances the read index by one.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a single byte from the ProtonBuffer.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if there is no readable bytes left in the buffer.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="writeByte(byte)"> |
| <h3>writeByte</h3> |
| <div class="member-signature"><span class="return-type"><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></span> <span class="element-name">writeByte</span><wbr><span class="parameters">(byte value)</span></div> |
| <div class="block">Writes a single byte to the buffer and advances the write index by one.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>value</code> - The byte to write into the buffer.</dd> |
| <dt>Returns:</dt> |
| <dd>this ProtonBuffer for chaining.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if there is no room in the buffer for this write operation.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBoolean(int)"> |
| <h3>getBoolean</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">boolean</span> <span class="element-name">getBoolean</span><wbr><span class="parameters">(int index)</span></div> |
| <div class="block">Reads a single byte at the given index and returns it as a boolean value, |
| without modification to the target buffer read offset.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - The index where the value should be read from.</dd> |
| <dt>Returns:</dt> |
| <dd>the value read from the given index.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if the index is negative or past the current buffer capacity.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setBoolean(int,boolean)"> |
| <h3>setBoolean</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></span> <span class="element-name">setBoolean</span><wbr><span class="parameters">(int index, |
| boolean value)</span></div> |
| <div class="block">Sets the boolean value at the given write index in this buffer's backing data store.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - The index to start the write from.</dd> |
| <dd><code>value</code> - The value to write at the given index.</dd> |
| <dt>Returns:</dt> |
| <dd>a reference to this ProtonBuffer for chaining.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if the index is negative or the write would exceed capacity.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readBoolean()"> |
| <h3>readBoolean</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">boolean</span> <span class="element-name">readBoolean</span>()</div> |
| <div class="block">Reads a boolean value from the buffer and advances the read index by one.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>boolean value read from the buffer.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if a value cannot be read from the buffer.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="writeBoolean(boolean)"> |
| <h3>writeBoolean</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></span> <span class="element-name">writeBoolean</span><wbr><span class="parameters">(boolean value)</span></div> |
| <div class="block">Writes a single boolean to the buffer and advances the write index by one.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>value</code> - The boolean to write into the buffer.</dd> |
| <dt>Returns:</dt> |
| <dd>this ProtonBuffer for chaining.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if there is no room in the buffer for this write operation.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getUnsignedByte(int)"> |
| <h3>getUnsignedByte</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">int</span> <span class="element-name">getUnsignedByte</span><wbr><span class="parameters">(int index)</span></div> |
| <div class="block">Gets a unsigned byte from the specified index, this method will not modify the read or write |
| index.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - The index into the buffer where the value should be read.</dd> |
| <dt>Returns:</dt> |
| <dd>the value read from the given index.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if the index is negative or past the current buffer capacity.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setUnsignedByte(int,int)"> |
| <h3>setUnsignedByte</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></span> <span class="element-name">setUnsignedByte</span><wbr><span class="parameters">(int index, |
| int value)</span></div> |
| <div class="block">Sets the unsigned byte value at the given write index in this buffer's backing data store.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - The index to start the write from.</dd> |
| <dd><code>value</code> - The value to write at the given index.</dd> |
| <dt>Returns:</dt> |
| <dd>a reference to this ProtonBuffer for chaining.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if the index is negative or the write would exceed capacity.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readUnsignedByte()"> |
| <h3>readUnsignedByte</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">int</span> <span class="element-name">readUnsignedByte</span>()</div> |
| <div class="block">Reads one byte from the buffer and advances the read index by one.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a single byte from the ProtonBuffer.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if there is no readable bytes left in the buffer.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="writeUnsignedByte(int)"> |
| <h3>writeUnsignedByte</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></span> <span class="element-name">writeUnsignedByte</span><wbr><span class="parameters">(int value)</span></div> |
| <div class="block">Writes a single byte to the buffer and advances the write index by one.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>value</code> - The byte to write into the buffer.</dd> |
| <dt>Returns:</dt> |
| <dd>this ProtonBuffer for chaining.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if there is no room in the buffer for this write operation.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getChar(int)"> |
| <h3>getChar</h3> |
| <div class="member-signature"><span class="return-type">char</span> <span class="element-name">getChar</span><wbr><span class="parameters">(int index)</span></div> |
| <div class="block">Gets a 2-byte char from the specified index, this method will not modify the read or write |
| index.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - The index into the buffer where the value should be read.</dd> |
| <dt>Returns:</dt> |
| <dd>the value read from the given index.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if the index is negative or past the current buffer capacity.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setChar(int,char)"> |
| <h3>setChar</h3> |
| <div class="member-signature"><span class="return-type"><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></span> <span class="element-name">setChar</span><wbr><span class="parameters">(int index, |
| char value)</span></div> |
| <div class="block">Sets the char value at the given write index in this buffer's backing data store.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - The index to start the write from.</dd> |
| <dd><code>value</code> - The value to write at the given index.</dd> |
| <dt>Returns:</dt> |
| <dd>a reference to this ProtonBuffer for chaining.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if the index is negative or the write would exceed capacity.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readChar()"> |
| <h3>readChar</h3> |
| <div class="member-signature"><span class="return-type">char</span> <span class="element-name">readChar</span>()</div> |
| <div class="block">Reads a character value from the buffer and advances the read index by four.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>char value read from the buffer.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if a value cannot be read from the buffer.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="writeChar(char)"> |
| <h3>writeChar</h3> |
| <div class="member-signature"><span class="return-type"><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></span> <span class="element-name">writeChar</span><wbr><span class="parameters">(char value)</span></div> |
| <div class="block">Writes a single character to the buffer and advances the write index by four.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>value</code> - The char to write into the buffer.</dd> |
| <dt>Returns:</dt> |
| <dd>this ProtonBuffer for chaining.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if there is no room in the buffer for this write operation.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getShort(int)"> |
| <h3>getShort</h3> |
| <div class="member-signature"><span class="return-type">short</span> <span class="element-name">getShort</span><wbr><span class="parameters">(int index)</span></div> |
| <div class="block">Gets a short from the specified index, this method will not modify the read or write |
| index.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - The index into the buffer where the value should be read.</dd> |
| <dt>Returns:</dt> |
| <dd>the value read from the given index.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if the index is negative or past the current buffer capacity.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setShort(int,short)"> |
| <h3>setShort</h3> |
| <div class="member-signature"><span class="return-type"><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></span> <span class="element-name">setShort</span><wbr><span class="parameters">(int index, |
| short value)</span></div> |
| <div class="block">Sets the short value at the given write index in this buffer's backing data store.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - The index to start the write from.</dd> |
| <dd><code>value</code> - The value to write at the given index.</dd> |
| <dt>Returns:</dt> |
| <dd>a reference to this ProtonBuffer for chaining.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if the index is negative or the write would exceed capacity.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readShort()"> |
| <h3>readShort</h3> |
| <div class="member-signature"><span class="return-type">short</span> <span class="element-name">readShort</span>()</div> |
| <div class="block">Reads a short value from the buffer and advances the read index by two.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>short value read from the buffer.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if a value cannot be read from the buffer.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="writeShort(short)"> |
| <h3>writeShort</h3> |
| <div class="member-signature"><span class="return-type"><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></span> <span class="element-name">writeShort</span><wbr><span class="parameters">(short value)</span></div> |
| <div class="block">Writes a single short to the buffer and advances the write index by two.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>value</code> - The short to write into the buffer.</dd> |
| <dt>Returns:</dt> |
| <dd>this ProtonBuffer for chaining.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if there is no room in the buffer for this write operation.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getUnsignedShort(int)"> |
| <h3>getUnsignedShort</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">int</span> <span class="element-name">getUnsignedShort</span><wbr><span class="parameters">(int index)</span></div> |
| <div class="block">Gets a unsigned short from the specified index, this method will not modify the read or write |
| index.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - The index into the buffer where the value should be read.</dd> |
| <dt>Returns:</dt> |
| <dd>the value read from the given index.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if the index is negative or past the current buffer capacity.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setUnsignedShort(int,int)"> |
| <h3>setUnsignedShort</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></span> <span class="element-name">setUnsignedShort</span><wbr><span class="parameters">(int index, |
| int value)</span></div> |
| <div class="block">Sets the short value at the given write index in this buffer's backing data store.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - The index to start the write from.</dd> |
| <dd><code>value</code> - The value to write at the given index.</dd> |
| <dt>Returns:</dt> |
| <dd>a reference to this ProtonBuffer for chaining.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if the index is negative or the write would exceed capacity.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readUnsignedShort()"> |
| <h3>readUnsignedShort</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">int</span> <span class="element-name">readUnsignedShort</span>()</div> |
| <div class="block">Reads an integer value from the buffer that represent the unsigned value of the short and |
| advances the read index by two.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>unsigned short value read from the buffer.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if a value cannot be read from the buffer.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="writeUnsignedShort(int)"> |
| <h3>writeUnsignedShort</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></span> <span class="element-name">writeUnsignedShort</span><wbr><span class="parameters">(int value)</span></div> |
| <div class="block">Writes a single short to the buffer using the input integer value and advances the write index by two.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>value</code> - The integer to write into the buffer as an unsigned short.</dd> |
| <dt>Returns:</dt> |
| <dd>this ProtonBuffer for chaining.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if there is no room in the buffer for this write operation.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getInt(int)"> |
| <h3>getInt</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name">getInt</span><wbr><span class="parameters">(int index)</span></div> |
| <div class="block">Gets a int from the specified index, this method will not modify the read or write |
| index.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - The index into the buffer where the value should be read.</dd> |
| <dt>Returns:</dt> |
| <dd>the value read from the given index.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if the index is negative or past the current buffer capacity.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setInt(int,int)"> |
| <h3>setInt</h3> |
| <div class="member-signature"><span class="return-type"><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></span> <span class="element-name">setInt</span><wbr><span class="parameters">(int index, |
| int value)</span></div> |
| <div class="block">Sets the int value at the given write index in this buffer's backing data store.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - The index to start the write from.</dd> |
| <dd><code>value</code> - The value to write at the given index.</dd> |
| <dt>Returns:</dt> |
| <dd>a reference to this ProtonBuffer for chaining.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if the index is negative or the write would exceed capacity.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readInt()"> |
| <h3>readInt</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name">readInt</span>()</div> |
| <div class="block">Reads a integer value from the buffer and advances the read index by four.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>integer value read from the buffer.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if a value cannot be read from the buffer.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="writeInt(int)"> |
| <h3>writeInt</h3> |
| <div class="member-signature"><span class="return-type"><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></span> <span class="element-name">writeInt</span><wbr><span class="parameters">(int value)</span></div> |
| <div class="block">Writes a single integer to the buffer and advances the write index by four.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>value</code> - The integer to write into the buffer.</dd> |
| <dt>Returns:</dt> |
| <dd>this ProtonBuffer for chaining.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if there is no room in the buffer for this write operation.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getUnsignedInt(int)"> |
| <h3>getUnsignedInt</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">long</span> <span class="element-name">getUnsignedInt</span><wbr><span class="parameters">(int index)</span></div> |
| <div class="block">Gets a unsigned int from the specified index, this method will not modify the read or write |
| index.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - The index into the buffer where the value should be read.</dd> |
| <dt>Returns:</dt> |
| <dd>the value read from the given index.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if the index is negative or past the current buffer capacity.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setUnsignedInt(int,long)"> |
| <h3>setUnsignedInt</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></span> <span class="element-name">setUnsignedInt</span><wbr><span class="parameters">(int index, |
| long value)</span></div> |
| <div class="block">Sets the long value at the given write index in this buffer's backing data store.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - The index to start the write from.</dd> |
| <dd><code>value</code> - The value to write at the given index.</dd> |
| <dt>Returns:</dt> |
| <dd>a reference to this ProtonBuffer for chaining.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if the index is negative or the write would exceed capacity.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readUnsignedInt()"> |
| <h3>readUnsignedInt</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">long</span> <span class="element-name">readUnsignedInt</span>()</div> |
| <div class="block">Reads a unsigned integer value from the buffer and advances the read index by four.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>long value read from the buffer.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if a value cannot be read from the buffer.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="writeUnsignedInt(long)"> |
| <h3>writeUnsignedInt</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></span> <span class="element-name">writeUnsignedInt</span><wbr><span class="parameters">(long value)</span></div> |
| <div class="block">Writes a single unsigned int to the buffer and advances the write index by four.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>value</code> - The long to write into the buffer.</dd> |
| <dt>Returns:</dt> |
| <dd>this ProtonBuffer for chaining.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if there is no room in the buffer for this write operation.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLong(int)"> |
| <h3>getLong</h3> |
| <div class="member-signature"><span class="return-type">long</span> <span class="element-name">getLong</span><wbr><span class="parameters">(int index)</span></div> |
| <div class="block">Gets a long from the specified index, this method will not modify the read or write |
| index.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - The index into the buffer where the value should be read.</dd> |
| <dt>Returns:</dt> |
| <dd>the value read from the given index.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if the index is negative or past the current buffer capacity.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setLong(int,long)"> |
| <h3>setLong</h3> |
| <div class="member-signature"><span class="return-type"><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></span> <span class="element-name">setLong</span><wbr><span class="parameters">(int index, |
| long value)</span></div> |
| <div class="block">Sets the long value at the given write index in this buffer's backing data store.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - The index to start the write from.</dd> |
| <dd><code>value</code> - The value to write at the given index.</dd> |
| <dt>Returns:</dt> |
| <dd>a reference to this ProtonBuffer for chaining.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if the index is negative or the write would exceed capacity.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readLong()"> |
| <h3>readLong</h3> |
| <div class="member-signature"><span class="return-type">long</span> <span class="element-name">readLong</span>()</div> |
| <div class="block">Reads a long value from the buffer and advances the read index by eight.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>long value read from the buffer.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if a value cannot be read from the buffer.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="writeLong(long)"> |
| <h3>writeLong</h3> |
| <div class="member-signature"><span class="return-type"><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></span> <span class="element-name">writeLong</span><wbr><span class="parameters">(long value)</span></div> |
| <div class="block">Writes a single long to the buffer and advances the write index by eight.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>value</code> - The long to write into the buffer.</dd> |
| <dt>Returns:</dt> |
| <dd>this ProtonBuffer for chaining.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if there is no room in the buffer for this write operation.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFloat(int)"> |
| <h3>getFloat</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">float</span> <span class="element-name">getFloat</span><wbr><span class="parameters">(int index)</span></div> |
| <div class="block">Gets a float from the specified index, this method will not modify the read or write |
| index.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - The index into the buffer where the value should be read.</dd> |
| <dt>Returns:</dt> |
| <dd>the value read from the given index.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if the index is negative or past the current buffer capacity.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setFloat(int,float)"> |
| <h3>setFloat</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></span> <span class="element-name">setFloat</span><wbr><span class="parameters">(int index, |
| float value)</span></div> |
| <div class="block">Sets the float value at the given write index in this buffer's backing data store.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - The index to start the write from.</dd> |
| <dd><code>value</code> - The value to write at the given index.</dd> |
| <dt>Returns:</dt> |
| <dd>a reference to this ProtonBuffer for chaining.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if the index is negative or the write would exceed capacity.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readFloat()"> |
| <h3>readFloat</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">float</span> <span class="element-name">readFloat</span>()</div> |
| <div class="block">Reads a float value from the buffer and advances the read index by four.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>float value read from the buffer.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if a value cannot be read from the buffer.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="writeFloat(float)"> |
| <h3>writeFloat</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></span> <span class="element-name">writeFloat</span><wbr><span class="parameters">(float value)</span></div> |
| <div class="block">Writes a single float to the buffer and advances the write index by four.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>value</code> - The float to write into the buffer.</dd> |
| <dt>Returns:</dt> |
| <dd>this ProtonBuffer for chaining.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if there is no room in the buffer for this write operation.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDouble(int)"> |
| <h3>getDouble</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">double</span> <span class="element-name">getDouble</span><wbr><span class="parameters">(int index)</span></div> |
| <div class="block">Gets a double from the specified index, this method will not modify the read or write |
| index.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - The index into the buffer where the value should be read.</dd> |
| <dt>Returns:</dt> |
| <dd>the value read from the given index.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if the index is negative or past the current buffer capacity.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setDouble(int,double)"> |
| <h3>setDouble</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></span> <span class="element-name">setDouble</span><wbr><span class="parameters">(int index, |
| double value)</span></div> |
| <div class="block">Sets the double value at the given write index in this buffer's backing data store.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - The index to start the write from.</dd> |
| <dd><code>value</code> - The value to write at the given index.</dd> |
| <dt>Returns:</dt> |
| <dd>a reference to this ProtonBuffer for chaining.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if the index is negative or the write would exceed capacity.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readDouble()"> |
| <h3>readDouble</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">double</span> <span class="element-name">readDouble</span>()</div> |
| <div class="block">Reads a double value from the buffer and advances the read index by eight.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>double value read from the buffer.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if a value cannot be read from the buffer.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="writeDouble(double)"> |
| <h3>writeDouble</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></span> <span class="element-name">writeDouble</span><wbr><span class="parameters">(double value)</span></div> |
| <div class="block">Writes a single double to the buffer and advances the write index by eight.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>value</code> - The double to write into the buffer.</dd> |
| <dt>Returns:</dt> |
| <dd>this ProtonBuffer for chaining.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if there is no room in the buffer for this write operation.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
