| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ProtonStreamDecoderState (Qpid ProtonJ2 Parent 1.0.0-M19 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.codec.decoders, class: ProtonStreamDecoderState"> |
| <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/ProtonStreamDecoderState.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><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </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.codec.decoders</a></div> |
| <h1 title="Class ProtonStreamDecoderState" class="title">Class ProtonStreamDecoderState</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.qpid.protonj2.codec.decoders.ProtonStreamDecoderState</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../StreamDecoderState.html" title="interface in org.apache.qpid.protonj2.codec">StreamDecoderState</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">ProtonStreamDecoderState</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| implements <a href="../StreamDecoderState.html" title="interface in org.apache.qpid.protonj2.codec">StreamDecoderState</a></span></div> |
| <div class="block">State object used by the Built in Decoder implementation.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.qpid.protonj2.codec.decoders.ProtonStreamDecoder)" class="member-name-link">ProtonStreamDecoderState</a><wbr>(<a href="ProtonStreamDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders">ProtonStreamDecoder</a> decoder)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Create a new <a href="../StreamDecoderState.html" title="interface in org.apache.qpid.protonj2.codec"><code>StreamDecoderState</code></a> instance that is joined forever to the given <a href="../Decoder.html" title="interface in org.apache.qpid.protonj2.codec"><code>Decoder</code></a>.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== 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-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete 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-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#decodeUTF8(java.io.InputStream,int)" class="member-name-link">decodeUTF8</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a> stream, |
| int length)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Given a stream that will provide UTF-8 encoded bytes, decode and return the String that |
| represents that UTF-8 value.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ProtonStreamDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders">ProtonStreamDecoder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDecoder()" class="member-name-link">getDecoder</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="UTF8StreamDecoder.html" title="interface in org.apache.qpid.protonj2.codec.decoders">UTF8StreamDecoder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getStringDecoder()" class="member-name-link">getStringDecoder</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ProtonStreamDecoderState.html" title="class in org.apache.qpid.protonj2.codec.decoders">ProtonStreamDecoderState</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Resets any intermediate state back to default values.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setStringDecoder(org.apache.qpid.protonj2.codec.decoders.UTF8StreamDecoder)" class="member-name-link">setStringDecoder</a><wbr>(<a href="UTF8StreamDecoder.html" title="interface in org.apache.qpid.protonj2.codec.decoders">UTF8StreamDecoder</a> stringDecoder)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets a custom UTF-8 <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a> decoder that will be used for all <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a> decoding done |
| from the encoder associated with this <a href="../StreamDecoderState.html" title="interface in org.apache.qpid.protonj2.codec"><code>StreamDecoderState</code></a> instance.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(org.apache.qpid.protonj2.codec.decoders.ProtonStreamDecoder)"> |
| <h3>ProtonStreamDecoderState</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ProtonStreamDecoderState</span><wbr><span class="parameters">(<a href="ProtonStreamDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders">ProtonStreamDecoder</a> decoder)</span></div> |
| <div class="block">Create a new <a href="../StreamDecoderState.html" title="interface in org.apache.qpid.protonj2.codec"><code>StreamDecoderState</code></a> instance that is joined forever to the given <a href="../Decoder.html" title="interface in org.apache.qpid.protonj2.codec"><code>Decoder</code></a>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>decoder</code> - The <a href="../StreamDecoder.html" title="interface in org.apache.qpid.protonj2.codec"><code>StreamDecoder</code></a> that this state instance is assigned to.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getDecoder()"> |
| <h3>getDecoder</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ProtonStreamDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders">ProtonStreamDecoder</a></span> <span class="element-name">getDecoder</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../StreamDecoderState.html#getDecoder()">getDecoder</a></code> in interface <code><a href="../StreamDecoderState.html" title="interface in org.apache.qpid.protonj2.codec">StreamDecoderState</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the <a href="../StreamDecoder.html" title="interface in org.apache.qpid.protonj2.codec"><code>StreamDecoder</code></a> that created this state object</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="reset()"> |
| <h3>reset</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ProtonStreamDecoderState.html" title="class in org.apache.qpid.protonj2.codec.decoders">ProtonStreamDecoderState</a></span> <span class="element-name">reset</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../StreamDecoderState.html#reset()">StreamDecoderState</a></code></span></div> |
| <div class="block">Resets any intermediate state back to default values.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../StreamDecoderState.html#reset()">reset</a></code> in interface <code><a href="../StreamDecoderState.html" title="interface in org.apache.qpid.protonj2.codec">StreamDecoderState</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>this <a href="../StreamDecoderState.html" title="interface in org.apache.qpid.protonj2.codec"><code>StreamDecoderState</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStringDecoder()"> |
| <h3>getStringDecoder</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="UTF8StreamDecoder.html" title="interface in org.apache.qpid.protonj2.codec.decoders">UTF8StreamDecoder</a></span> <span class="element-name">getStringDecoder</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the currently set custom UTF-8 <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a> decoder or null if non set.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setStringDecoder(org.apache.qpid.protonj2.codec.decoders.UTF8StreamDecoder)"> |
| <h3>setStringDecoder</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setStringDecoder</span><wbr><span class="parameters">(<a href="UTF8StreamDecoder.html" title="interface in org.apache.qpid.protonj2.codec.decoders">UTF8StreamDecoder</a> stringDecoder)</span></div> |
| <div class="block">Sets a custom UTF-8 <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a> decoder that will be used for all <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a> decoding done |
| from the encoder associated with this <a href="../StreamDecoderState.html" title="interface in org.apache.qpid.protonj2.codec"><code>StreamDecoderState</code></a> instance. If no decoder is registered |
| then the implementation uses its own decoding algorithm.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>stringDecoder</code> - a custom <a href="UTF8Decoder.html" title="interface in org.apache.qpid.protonj2.codec.decoders"><code>UTF8Decoder</code></a> that will be used for all <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a> decoding.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="decodeUTF8(java.io.InputStream,int)"> |
| <h3>decodeUTF8</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">decodeUTF8</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a> stream, |
| int length)</span> |
| throws <span class="exceptions"><a href="../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../StreamDecoderState.html#decodeUTF8(java.io.InputStream,int)">StreamDecoderState</a></code></span></div> |
| <div class="block">Given a stream that will provide UTF-8 encoded bytes, decode and return the String that |
| represents that UTF-8 value.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../StreamDecoderState.html#decodeUTF8(java.io.InputStream,int)">decodeUTF8</a></code> in interface <code><a href="../StreamDecoderState.html" title="interface in org.apache.qpid.protonj2.codec">StreamDecoderState</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>stream</code> - A stream from which the UTF-8 encoded bytes are to be decoded.</dd> |
| <dd><code>length</code> - The number of bytes in the passed <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link"><code>InputStream</code></a> that comprise the UTF-8 encoding.</dd> |
| <dt>Returns:</dt> |
| <dd>a String that represents the UTF-8 decoded bytes.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></code> - if an error occurs while decoding the string value.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
