| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ProtonEncoderState (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.codec.encoders, class: ProtonEncoderState"> |
| <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/ProtonEncoderState.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.encoders</a></div> |
| <h1 title="Class ProtonEncoderState" class="title">Class ProtonEncoderState</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.encoders.ProtonEncoderState</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../EncoderState.html" title="interface in org.apache.qpid.protonj2.codec">EncoderState</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">ProtonEncoderState</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="../EncoderState.html" title="interface in org.apache.qpid.protonj2.codec">EncoderState</a></span></div> |
| <div class="block">State object used by the Built in Encoder 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.encoders.ProtonEncoder)" class="member-name-link">ProtonEncoderState</a><wbr>(<a href="ProtonEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders">ProtonEncoder</a> encoder)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a new <a href="ProtonEncoderState.html" title="class in org.apache.qpid.protonj2.codec.encoders"><code>ProtonEncoderState</code></a> that is linked to the given <a href="ProtonEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders"><code>ProtonEncoder</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="../../buffer/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-tab4"><code><a href="#encodeUTF8(org.apache.qpid.protonj2.buffer.ProtonBuffer,java.lang.CharSequence)" class="member-name-link">encodeUTF8</a><wbr>(<a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> buffer, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a> sequence)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Encodes the given sequence of characters in UTF8 to the given buffer.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ProtonEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders">ProtonEncoder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEncoder()" class="member-name-link">getEncoder</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="UTF8Encoder.html" title="interface in org.apache.qpid.protonj2.codec.encoders">UTF8Encoder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUTF8Encoder()" class="member-name-link">getUTF8Encoder</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="ProtonEncoderState.html" title="class in org.apache.qpid.protonj2.codec.encoders">ProtonEncoderState</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><a href="ProtonEncoderState.html" title="class in org.apache.qpid.protonj2.codec.encoders">ProtonEncoderState</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setUTF8Encoder(org.apache.qpid.protonj2.codec.encoders.UTF8Encoder)" class="member-name-link">setUTF8Encoder</a><wbr>(<a href="UTF8Encoder.html" title="interface in org.apache.qpid.protonj2.codec.encoders">UTF8Encoder</a> utf8Encoder)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Configures a custom <a href="UTF8Encoder.html" title="interface in org.apache.qpid.protonj2.codec.encoders"><code>UTF8Encoder</code></a> instance that will be used for all String decoding |
| done by the parent <a href="../Encoder.html" title="interface in org.apache.qpid.protonj2.codec"><code>Encoder</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.encoders.ProtonEncoder)"> |
| <h3>ProtonEncoderState</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ProtonEncoderState</span><wbr><span class="parameters">(<a href="ProtonEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders">ProtonEncoder</a> encoder)</span></div> |
| <div class="block">Creates a new <a href="ProtonEncoderState.html" title="class in org.apache.qpid.protonj2.codec.encoders"><code>ProtonEncoderState</code></a> that is linked to the given <a href="ProtonEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders"><code>ProtonEncoder</code></a>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>encoder</code> - The <a href="../Encoder.html" title="interface in org.apache.qpid.protonj2.codec"><code>Encoder</code></a> that this encoder 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="getEncoder()"> |
| <h3>getEncoder</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ProtonEncoder.html" title="class in org.apache.qpid.protonj2.codec.encoders">ProtonEncoder</a></span> <span class="element-name">getEncoder</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../EncoderState.html#getEncoder()">getEncoder</a></code> in interface <code><a href="../EncoderState.html" title="interface in org.apache.qpid.protonj2.codec">EncoderState</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the Encoder instance that create this state object.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getUTF8Encoder()"> |
| <h3>getUTF8Encoder</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="UTF8Encoder.html" title="interface in org.apache.qpid.protonj2.codec.encoders">UTF8Encoder</a></span> <span class="element-name">getUTF8Encoder</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the user configured custom <a href="UTF8Encoder.html" title="interface in org.apache.qpid.protonj2.codec.encoders"><code>UTF8Encoder</code></a> instance or null if none set.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setUTF8Encoder(org.apache.qpid.protonj2.codec.encoders.UTF8Encoder)"> |
| <h3>setUTF8Encoder</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ProtonEncoderState.html" title="class in org.apache.qpid.protonj2.codec.encoders">ProtonEncoderState</a></span> <span class="element-name">setUTF8Encoder</span><wbr><span class="parameters">(<a href="UTF8Encoder.html" title="interface in org.apache.qpid.protonj2.codec.encoders">UTF8Encoder</a> utf8Encoder)</span></div> |
| <div class="block">Configures a custom <a href="UTF8Encoder.html" title="interface in org.apache.qpid.protonj2.codec.encoders"><code>UTF8Encoder</code></a> instance that will be used for all String decoding |
| done by the parent <a href="../Encoder.html" title="interface in org.apache.qpid.protonj2.codec"><code>Encoder</code></a> instance.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>utf8Encoder</code> - The user specified <a href="UTF8Encoder.html" title="interface in org.apache.qpid.protonj2.codec.encoders"><code>UTF8Encoder</code></a> or null to clear a previous configuration.</dd> |
| <dt>Returns:</dt> |
| <dd>this <a href="../Encoder.html" title="interface in org.apache.qpid.protonj2.codec"><code>Encoder</code></a> instance.</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="ProtonEncoderState.html" title="class in org.apache.qpid.protonj2.codec.encoders">ProtonEncoderState</a></span> <span class="element-name">reset</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../EncoderState.html#reset()">EncoderState</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="../EncoderState.html#reset()">reset</a></code> in interface <code><a href="../EncoderState.html" title="interface in org.apache.qpid.protonj2.codec">EncoderState</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>this <a href="../EncoderState.html" title="interface in org.apache.qpid.protonj2.codec"><code>EncoderState</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="encodeUTF8(org.apache.qpid.protonj2.buffer.ProtonBuffer,java.lang.CharSequence)"> |
| <h3>encodeUTF8</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></span> <span class="element-name">encodeUTF8</span><wbr><span class="parameters">(<a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> buffer, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a> sequence)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../EncoderState.html#encodeUTF8(org.apache.qpid.protonj2.buffer.ProtonBuffer,java.lang.CharSequence)">EncoderState</a></code></span></div> |
| <div class="block">Encodes the given sequence of characters in UTF8 to the given buffer.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../EncoderState.html#encodeUTF8(org.apache.qpid.protonj2.buffer.ProtonBuffer,java.lang.CharSequence)">encodeUTF8</a></code> in interface <code><a href="../EncoderState.html" title="interface in org.apache.qpid.protonj2.codec">EncoderState</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>buffer</code> - A ProtonBuffer where the UTF-8 encoded bytes should be written.</dd> |
| <dd><code>sequence</code> - A <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link"><code>CharSequence</code></a> representing the UTF-8 bytes to encode</dd> |
| <dt>Returns:</dt> |
| <dd>a reference to the encoding buffer for chaining</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> |
