| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.11) on Wed May 12 10:10:59 EDT 2021 --> |
| <title>ProtonStreamUtils (Qpid ProtonJ2 Parent 1.0.0-M1 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2021-05-12"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../../jquery/jquery-3.5.1.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ProtonStreamUtils (Qpid ProtonJ2 Parent 1.0.0-M1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ProtonStreamUtils.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>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 id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.qpid.protonj2.codec.decoders</a></div> |
| <h2 title="Class ProtonStreamUtils" class="title">Class ProtonStreamUtils</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.qpid.protonj2.codec.decoders.ProtonStreamUtils</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <pre>public abstract class <span class="typeNameLabel">ProtonStreamUtils</span> |
| extends java.lang.Object</pre> |
| <div class="block">Set of Utility methods useful when dealing with byte arrays and other |
| primitive types.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">ProtonStreamUtils</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static byte</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readByte(java.io.InputStream)">readByte</a></span>​(java.io.InputStream stream)</code></th> |
| <td class="colLast"> |
| <div class="block">Reads a single byte from the given <code>InputStream</code> and thrown a <a href="../DecodeException.html" title="class in org.apache.qpid.protonj2.codec"><code>DecodeException</code></a> if the |
| <code>InputStream</code> indicates an EOF condition was encountered.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static byte[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readBytes(java.io.InputStream,int)">readBytes</a></span>​(java.io.InputStream stream, |
| int length)</code></th> |
| <td class="colLast"> |
| <div class="block">Reads the given number of bytes from the provided <code>InputStream</code> into an array and |
| return that to the caller.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static double</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readDouble(java.io.InputStream)">readDouble</a></span>​(java.io.InputStream stream)</code></th> |
| <td class="colLast"> |
| <div class="block">Reads a double value from the given <code>InputStream</code> and thrown a <a href="../DecodeException.html" title="class in org.apache.qpid.protonj2.codec"><code>DecodeException</code></a> if the |
| <code>InputStream</code> indicates an EOF condition was encountered.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static byte</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readEncodingCode(java.io.InputStream)">readEncodingCode</a></span>​(java.io.InputStream stream)</code></th> |
| <td class="colLast"> |
| <div class="block">Reads a single byte from the given <code>InputStream</code> and thrown a <a href="../DecodeException.html" title="class in org.apache.qpid.protonj2.codec"><code>DecodeException</code></a> if the |
| <code>InputStream</code> indicates an EOF condition was encountered.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static float</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readFloat(java.io.InputStream)">readFloat</a></span>​(java.io.InputStream stream)</code></th> |
| <td class="colLast"> |
| <div class="block">Reads a float value from the given <code>InputStream</code> and thrown a <a href="../DecodeException.html" title="class in org.apache.qpid.protonj2.codec"><code>DecodeException</code></a> if the |
| <code>InputStream</code> indicates an EOF condition was encountered.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readInt(java.io.InputStream)">readInt</a></span>​(java.io.InputStream stream)</code></th> |
| <td class="colLast"> |
| <div class="block">Reads a integer value from the given <code>InputStream</code> and thrown a <a href="../DecodeException.html" title="class in org.apache.qpid.protonj2.codec"><code>DecodeException</code></a> if the |
| <code>InputStream</code> indicates an EOF condition was encountered.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readLong(java.io.InputStream)">readLong</a></span>​(java.io.InputStream stream)</code></th> |
| <td class="colLast"> |
| <div class="block">Reads a long value from the given <code>InputStream</code> and thrown a <a href="../DecodeException.html" title="class in org.apache.qpid.protonj2.codec"><code>DecodeException</code></a> if the |
| <code>InputStream</code> indicates an EOF condition was encountered.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static short</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readShort(java.io.InputStream)">readShort</a></span>​(java.io.InputStream stream)</code></th> |
| <td class="colLast"> |
| <div class="block">Reads a short value from the given <code>InputStream</code> and thrown a <a href="../DecodeException.html" title="class in org.apache.qpid.protonj2.codec"><code>DecodeException</code></a> if the |
| <code>InputStream</code> indicates an EOF condition was encountered.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static java.io.InputStream</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reset(java.io.InputStream)">reset</a></span>​(java.io.InputStream stream)</code></th> |
| <td class="colLast"> |
| <div class="block">Attempts to reset the provided <code>InputStream</code> to a previously marked point.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>static java.io.InputStream</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#skipBytes(java.io.InputStream,long)">skipBytes</a></span>​(java.io.InputStream stream, |
| long amount)</code></th> |
| <td class="colLast"> |
| <div class="block">Attempts to skip the given number of bytes from the provided <code>InputStream</code> instance and |
| throws a DecodeException if an error occurs during the skip.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>static java.io.OutputStream</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#writeByte(byte,java.io.OutputStream)">writeByte</a></span>​(byte value, |
| java.io.OutputStream stream)</code></th> |
| <td class="colLast"> |
| <div class="block">Write the given <code>Byte</code> to the target <code>OutputStream</code>.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>static java.io.OutputStream</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#writeInt(int,java.io.OutputStream)">writeInt</a></span>​(int value, |
| java.io.OutputStream stream)</code></th> |
| <td class="colLast"> |
| <div class="block">Write the given <code>Integer</code> to the target <code>OutputStream</code>.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>static java.io.OutputStream</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#writeLong(long,java.io.OutputStream)">writeLong</a></span>​(long value, |
| java.io.OutputStream stream)</code></th> |
| <td class="colLast"> |
| <div class="block">Write the given <code>Long</code> to the target <code>OutputStream</code>.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>static java.io.OutputStream</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#writeShort(short,java.io.OutputStream)">writeShort</a></span>​(short value, |
| java.io.OutputStream stream)</code></th> |
| <td class="colLast"> |
| <div class="block">Write the given <code>Short</code> to the target <code>OutputStream</code>.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ProtonStreamUtils</h4> |
| <pre>public ProtonStreamUtils()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="writeByte(byte,java.io.OutputStream)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeByte</h4> |
| <pre class="methodSignature">public static java.io.OutputStream writeByte​(byte value, |
| java.io.OutputStream stream) |
| throws <a href="../EncodeException.html" title="class in org.apache.qpid.protonj2.codec">EncodeException</a></pre> |
| <div class="block">Write the given <code>Byte</code> to the target <code>OutputStream</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - the value to write to the <code>OutputStream</code>.</dd> |
| <dd><code>stream</code> - the <code>OutputStream</code> where the target value is to be written.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the given <code>OutputStream</code> instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../EncodeException.html" title="class in org.apache.qpid.protonj2.codec">EncodeException</a></code> - if an error occurs while writing to the target <code>OutputStream</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="writeShort(short,java.io.OutputStream)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeShort</h4> |
| <pre class="methodSignature">public static java.io.OutputStream writeShort​(short value, |
| java.io.OutputStream stream) |
| throws <a href="../EncodeException.html" title="class in org.apache.qpid.protonj2.codec">EncodeException</a></pre> |
| <div class="block">Write the given <code>Short</code> to the target <code>OutputStream</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - the value to write to the <code>OutputStream</code>.</dd> |
| <dd><code>stream</code> - the <code>OutputStream</code> where the target value is to be written.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the given <code>OutputStream</code> instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../EncodeException.html" title="class in org.apache.qpid.protonj2.codec">EncodeException</a></code> - if an error occurs while writing to the target <code>OutputStream</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="writeInt(int,java.io.OutputStream)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeInt</h4> |
| <pre class="methodSignature">public static java.io.OutputStream writeInt​(int value, |
| java.io.OutputStream stream) |
| throws <a href="../EncodeException.html" title="class in org.apache.qpid.protonj2.codec">EncodeException</a></pre> |
| <div class="block">Write the given <code>Integer</code> to the target <code>OutputStream</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - the value to write to the <code>OutputStream</code>.</dd> |
| <dd><code>stream</code> - the <code>OutputStream</code> where the target value is to be written.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the given <code>OutputStream</code> instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../EncodeException.html" title="class in org.apache.qpid.protonj2.codec">EncodeException</a></code> - if an error occurs while writing to the target <code>OutputStream</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="writeLong(long,java.io.OutputStream)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeLong</h4> |
| <pre class="methodSignature">public static java.io.OutputStream writeLong​(long value, |
| java.io.OutputStream stream) |
| throws <a href="../EncodeException.html" title="class in org.apache.qpid.protonj2.codec">EncodeException</a></pre> |
| <div class="block">Write the given <code>Long</code> to the target <code>OutputStream</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - the value to write to the <code>OutputStream</code>.</dd> |
| <dd><code>stream</code> - the <code>OutputStream</code> where the target value is to be written.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the given <code>OutputStream</code> instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../EncodeException.html" title="class in org.apache.qpid.protonj2.codec">EncodeException</a></code> - if an error occurs while writing to the target <code>OutputStream</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="readBytes(java.io.InputStream,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readBytes</h4> |
| <pre class="methodSignature">public static byte[] readBytes​(java.io.InputStream stream, |
| int length) |
| throws <a href="../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></pre> |
| <div class="block">Reads the given number of bytes from the provided <code>InputStream</code> into an array and |
| return that to the caller. If the requested number of bytes cannot be read from the stream |
| an <a href="../DecodeException.html" title="class in org.apache.qpid.protonj2.codec"><code>DecodeException</code></a> is thrown to indicate an underflow.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>stream</code> - The <code>InputStream</code> where the bytes should be read from.</dd> |
| <dd><code>length</code> - The number of bytes to read from the given input stream.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a byte array containing the requested number of bytes read from the given <code>InputStream</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></code> - if an error occurs reading from the stream or insufficient bytes are available.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="readEncodingCode(java.io.InputStream)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readEncodingCode</h4> |
| <pre class="methodSignature">public static byte readEncodingCode​(java.io.InputStream stream) |
| throws <a href="../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></pre> |
| <div class="block">Reads a single byte from the given <code>InputStream</code> and thrown a <a href="../DecodeException.html" title="class in org.apache.qpid.protonj2.codec"><code>DecodeException</code></a> if the |
| <code>InputStream</code> indicates an EOF condition was encountered.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>stream</code> - The <code>InputStream</code> where the bytes should be read from.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the given byte that was read from the stream.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></code> - if an error occurs during the read or EOF is reached.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="readByte(java.io.InputStream)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readByte</h4> |
| <pre class="methodSignature">public static byte readByte​(java.io.InputStream stream) |
| throws <a href="../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></pre> |
| <div class="block">Reads a single byte from the given <code>InputStream</code> and thrown a <a href="../DecodeException.html" title="class in org.apache.qpid.protonj2.codec"><code>DecodeException</code></a> if the |
| <code>InputStream</code> indicates an EOF condition was encountered.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>stream</code> - The <code>InputStream</code> where the bytes should be read from.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the given byte that was read from the stream.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></code> - if an error occurs during the read or EOF is reached.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="readShort(java.io.InputStream)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readShort</h4> |
| <pre class="methodSignature">public static short readShort​(java.io.InputStream stream)</pre> |
| <div class="block">Reads a short value from the given <code>InputStream</code> and thrown a <a href="../DecodeException.html" title="class in org.apache.qpid.protonj2.codec"><code>DecodeException</code></a> if the |
| <code>InputStream</code> indicates an EOF condition was encountered.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>stream</code> - The <code>InputStream</code> where the bytes should be read from.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the given byte that was read from the stream.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></code> - if an error occurs during the read or EOF is reached.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="readInt(java.io.InputStream)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readInt</h4> |
| <pre class="methodSignature">public static int readInt​(java.io.InputStream stream)</pre> |
| <div class="block">Reads a integer value from the given <code>InputStream</code> and thrown a <a href="../DecodeException.html" title="class in org.apache.qpid.protonj2.codec"><code>DecodeException</code></a> if the |
| <code>InputStream</code> indicates an EOF condition was encountered.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>stream</code> - The <code>InputStream</code> where the bytes should be read from.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the given byte that was read from the stream.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></code> - if an error occurs during the read or EOF is reached.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="readLong(java.io.InputStream)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readLong</h4> |
| <pre class="methodSignature">public static long readLong​(java.io.InputStream stream)</pre> |
| <div class="block">Reads a long value from the given <code>InputStream</code> and thrown a <a href="../DecodeException.html" title="class in org.apache.qpid.protonj2.codec"><code>DecodeException</code></a> if the |
| <code>InputStream</code> indicates an EOF condition was encountered.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>stream</code> - The <code>InputStream</code> where the bytes should be read from.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the given byte that was read from the stream.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></code> - if an error occurs during the read or EOF is reached.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="readFloat(java.io.InputStream)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readFloat</h4> |
| <pre class="methodSignature">public static float readFloat​(java.io.InputStream stream)</pre> |
| <div class="block">Reads a float value from the given <code>InputStream</code> and thrown a <a href="../DecodeException.html" title="class in org.apache.qpid.protonj2.codec"><code>DecodeException</code></a> if the |
| <code>InputStream</code> indicates an EOF condition was encountered.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>stream</code> - The <code>InputStream</code> where the bytes should be read from.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the given byte that was read from the stream.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></code> - if an error occurs during the read or EOF is reached.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="readDouble(java.io.InputStream)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readDouble</h4> |
| <pre class="methodSignature">public static double readDouble​(java.io.InputStream stream)</pre> |
| <div class="block">Reads a double value from the given <code>InputStream</code> and thrown a <a href="../DecodeException.html" title="class in org.apache.qpid.protonj2.codec"><code>DecodeException</code></a> if the |
| <code>InputStream</code> indicates an EOF condition was encountered.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>stream</code> - The <code>InputStream</code> where the bytes should be read from.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the given byte that was read from the stream.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></code> - if an error occurs during the read or EOF is reached.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="skipBytes(java.io.InputStream,long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>skipBytes</h4> |
| <pre class="methodSignature">public static java.io.InputStream skipBytes​(java.io.InputStream stream, |
| long amount)</pre> |
| <div class="block">Attempts to skip the given number of bytes from the provided <code>InputStream</code> instance and |
| throws a DecodeException if an error occurs during the skip.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>stream</code> - The <code>InputStream</code> where the bytes should be read from.</dd> |
| <dd><code>amount</code> - The number of bytes that should be skipped.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>InputStream</code> instance that was passed.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></code> - if an error occurs during the read or EOF is reached.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="reset(java.io.InputStream)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>reset</h4> |
| <pre class="methodSignature">public static java.io.InputStream reset​(java.io.InputStream stream) |
| throws <a href="../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></pre> |
| <div class="block">Attempts to reset the provided <code>InputStream</code> to a previously marked point. If an error occurs |
| this method throws an DecodeException to describe the error.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>stream</code> - The <code>InputStream</code> that is to be reset.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>InputStream</code> instance that was passed.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></code> - if an error occurs during the reset.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ProtonStreamUtils.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |