Google Git
Sign in
apache / qpid-site / a52bbf4a24b0bdf923763f81d78481d22102177f / . / input / releases / qpid-protonj2-1.0.0-M9 / api / org / apache / qpid / protonj2 / codec / decoders / primitives / AbstractSymbolTypeDecoder.html
blob: b8a9c6c7118e6f33ed06f06075600f9d3934da46 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>AbstractSymbolTypeDecoder (Qpid ProtonJ2 Parent 1.0.0-M9 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AbstractSymbolTypeDecoder (Qpid ProtonJ2 Parent 1.0.0-M9 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<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/AbstractSymbolTypeDecoder.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="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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">&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.qpid.protonj2.codec.decoders.primitives</a></div>
<h2 title="Class AbstractSymbolTypeDecoder" class="title">Class AbstractSymbolTypeDecoder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../AbstractPrimitiveTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders">org.apache.qpid.protonj2.codec.decoders.AbstractPrimitiveTypeDecoder</a>&lt;<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.qpid.protonj2.codec.decoders.primitives.AbstractSymbolTypeDecoder</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="SymbolTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec.decoders.primitives">SymbolTypeDecoder</a></code>, <code><a href="../PrimitiveTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec.decoders">PrimitiveTypeDecoder</a>&lt;<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>&gt;</code>, <code><a href="../../StreamTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">StreamTypeDecoder</a>&lt;<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>&gt;</code>, <code><a href="../../TypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">TypeDecoder</a>&lt;<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>&gt;</code></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="Symbol32TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">Symbol32TypeDecoder</a></code>, <code><a href="Symbol8TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">Symbol8TypeDecoder</a></code></dd>
</dl>
<hr>
<pre>public abstract class <span class="typeNameLabel">AbstractSymbolTypeDecoder</span>
extends <a href="../AbstractPrimitiveTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders">AbstractPrimitiveTypeDecoder</a>&lt;<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>&gt;
implements <a href="SymbolTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec.decoders.primitives">SymbolTypeDecoder</a></pre>
<div class="block">Base class for the Symbol decoders used on AMQP Symbol 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">&nbsp;</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()">AbstractSymbolTypeDecoder</a></span>()</code></th>
<td class="colLast">&nbsp;</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>protected abstract int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readSize(java.io.InputStream)">readSize</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a>&nbsp;stream)</code></th>
<td class="colLast">
<div class="block">Subclasses must read the correct number of bytes from the buffer to determine the
size of the encoded Symbol value.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected abstract int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readSize(org.apache.qpid.protonj2.buffer.ProtonBuffer)">readSize</a></span>&#8203;(<a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a>&nbsp;buffer)</code></th>
<td class="colLast">
<div class="block">Subclasses must read the correct number of bytes from the buffer to determine the
size of the encoded Symbol value.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readString(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState)">readString</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a>&nbsp;stream,
<a href="../../StreamDecoderState.html" title="interface in org.apache.qpid.protonj2.codec">StreamDecoderState</a>&nbsp;state)</code></th>
<td class="colLast">
<div class="block">Reads a String view of an encoded Symbol value from the given buffer.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readString(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState)">readString</a></span>&#8203;(<a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a>&nbsp;buffer,
<a href="../../DecoderState.html" title="interface in org.apache.qpid.protonj2.codec">DecoderState</a>&nbsp;state)</code></th>
<td class="colLast">
<div class="block">Reads a String view of an encoded Symbol value from the given buffer.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readValue(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState)">readValue</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a>&nbsp;stream,
<a href="../../StreamDecoderState.html" title="interface in org.apache.qpid.protonj2.codec">StreamDecoderState</a>&nbsp;state)</code></th>
<td class="colLast">
<div class="block">Reads the next type from the given buffer and returns it.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readValue(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState)">readValue</a></span>&#8203;(<a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a>&nbsp;buffer,
<a href="../../DecoderState.html" title="interface in org.apache.qpid.protonj2.codec">DecoderState</a>&nbsp;state)</code></th>
<td class="colLast">
<div class="block">Reads the next type from the given buffer and returns it.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#skipValue(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState)">skipValue</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a>&nbsp;stream,
<a href="../../StreamDecoderState.html" title="interface in org.apache.qpid.protonj2.codec">StreamDecoderState</a>&nbsp;state)</code></th>
<td class="colLast">
<div class="block">Skips over the bytes that compose the type this descriptor decodes.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#skipValue(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState)">skipValue</a></span>&#8203;(<a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a>&nbsp;buffer,
<a href="../../DecoderState.html" title="interface in org.apache.qpid.protonj2.codec">DecoderState</a>&nbsp;state)</code></th>
<td class="colLast">
<div class="block">Skips over the bytes that compose the type this descriptor decodes.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.qpid.protonj2.codec.decoders.AbstractPrimitiveTypeDecoder">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.qpid.protonj2.codec.decoders.<a href="../AbstractPrimitiveTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders">AbstractPrimitiveTypeDecoder</a></h3>
<code><a href="../AbstractPrimitiveTypeDecoder.html#isArrayType()">isArrayType</a>, <a href="../AbstractPrimitiveTypeDecoder.html#isJavaPrimitive()">isJavaPrimitive</a>, <a href="../AbstractPrimitiveTypeDecoder.html#readArrayElements(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState,int)">readArrayElements</a>, <a href="../AbstractPrimitiveTypeDecoder.html#readArrayElements(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState,int)">readArrayElements</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.qpid.protonj2.codec.decoders.PrimitiveTypeDecoder">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.qpid.protonj2.codec.decoders.<a href="../PrimitiveTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec.decoders">PrimitiveTypeDecoder</a></h3>
<code><a href="../PrimitiveTypeDecoder.html#getTypeCode()">getTypeCode</a>, <a href="../PrimitiveTypeDecoder.html#isJavaPrimitive()">isJavaPrimitive</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.qpid.protonj2.codec.StreamTypeDecoder">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.qpid.protonj2.codec.<a href="../../StreamTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">StreamTypeDecoder</a></h3>
<code><a href="../../StreamTypeDecoder.html#getTypeClass()">getTypeClass</a>, <a href="../../StreamTypeDecoder.html#isArrayType()">isArrayType</a>, <a href="../../StreamTypeDecoder.html#readArrayElements(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState,int)">readArrayElements</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.qpid.protonj2.codec.decoders.primitives.SymbolTypeDecoder">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.qpid.protonj2.codec.decoders.primitives.<a href="SymbolTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec.decoders.primitives">SymbolTypeDecoder</a></h3>
<code><a href="SymbolTypeDecoder.html#getTypeClass()">getTypeClass</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.qpid.protonj2.codec.TypeDecoder">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.qpid.protonj2.codec.<a href="../../TypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">TypeDecoder</a></h3>
<code><a href="../../TypeDecoder.html#isArrayType()">isArrayType</a>, <a href="../../TypeDecoder.html#readArrayElements(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState,int)">readArrayElements</a></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="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractSymbolTypeDecoder</h4>
<pre>public&nbsp;AbstractSymbolTypeDecoder()</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="readValue(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readValue</h4>
<pre class="methodSignature">public&nbsp;<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>&nbsp;readValue&#8203;(<a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a>&nbsp;buffer,
<a href="../../DecoderState.html" title="interface in org.apache.qpid.protonj2.codec">DecoderState</a>&nbsp;state)
throws <a href="../../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../TypeDecoder.html#readValue(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState)">TypeDecoder</a></code></span></div>
<div class="block">Reads the next type from the given buffer and returns it.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../TypeDecoder.html#readValue(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState)">readValue</a></code>&nbsp;in interface&nbsp;<code><a href="../../TypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">TypeDecoder</a>&lt;<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>buffer</code> - the source of encoded data.</dd>
<dd><code>state</code> - the current state of the decoder.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the next instance in the stream that this decoder handles.</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 is encountered while reading the next value.</dd>
</dl>
</li>
</ul>
<a id="readString(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readString</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;readString&#8203;(<a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a>&nbsp;buffer,
<a href="../../DecoderState.html" title="interface in org.apache.qpid.protonj2.codec">DecoderState</a>&nbsp;state)
throws <a href="../../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></pre>
<div class="block">Reads a String view of an encoded Symbol value from the given buffer.
<p>
This method has the same result as calling the Symbol reading variant
<a href="#readValue(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState)"><code>readValue(ProtonBuffer, DecoderState)</code></a> and then invoking the toString
method on the resulting Symbol.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>buffer</code> - The buffer to read the encoded symbol from.</dd>
<dd><code>state</code> - The encoder state that applied to this decode operation.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a String view of the encoded Symbol value.</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 decoding the Symbol from the given buffer.</dd>
</dl>
</li>
</ul>
<a id="readValue(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readValue</h4>
<pre class="methodSignature">public&nbsp;<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>&nbsp;readValue&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a>&nbsp;stream,
<a href="../../StreamDecoderState.html" title="interface in org.apache.qpid.protonj2.codec">StreamDecoderState</a>&nbsp;state)
throws <a href="../../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../StreamTypeDecoder.html#readValue(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState)">StreamTypeDecoder</a></code></span></div>
<div class="block">Reads the next type from the given buffer and returns it.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../StreamTypeDecoder.html#readValue(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState)">readValue</a></code>&nbsp;in interface&nbsp;<code><a href="../../StreamTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">StreamTypeDecoder</a>&lt;<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stream</code> - the source of encoded data.</dd>
<dd><code>state</code> - the current state of the decoder.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the next instance in the stream that this decoder handles.</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 is encountered while reading the next value.</dd>
</dl>
</li>
</ul>
<a id="readString(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readString</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;readString&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a>&nbsp;stream,
<a href="../../StreamDecoderState.html" title="interface in org.apache.qpid.protonj2.codec">StreamDecoderState</a>&nbsp;state)
throws <a href="../../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></pre>
<div class="block">Reads a String view of an encoded Symbol value from the given buffer.
<p>
This method has the same result as calling the Symbol reading variant
<a href="#readValue(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState)"><code>readValue(ProtonBuffer, DecoderState)</code></a> and then invoking the toString
method on the resulting Symbol.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stream</code> - The InputStream to read the encoded symbol from.</dd>
<dd><code>state</code> - The encoder state that applied to this decode operation.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a String view of the encoded Symbol value.</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 decoding the Symbol from the given buffer.</dd>
</dl>
</li>
</ul>
<a id="skipValue(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>skipValue</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;skipValue&#8203;(<a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a>&nbsp;buffer,
<a href="../../DecoderState.html" title="interface in org.apache.qpid.protonj2.codec">DecoderState</a>&nbsp;state)
throws <a href="../../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../TypeDecoder.html#skipValue(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState)">TypeDecoder</a></code></span></div>
<div class="block">Skips over the bytes that compose the type this descriptor decodes.
<p>
Skipping values can be used when the type is not used or processed by the
application doing the decoding. An example might be an AMQP message decoder
that only needs to decode certain parts of the message and not others.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../TypeDecoder.html#skipValue(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState)">skipValue</a></code>&nbsp;in interface&nbsp;<code><a href="../../TypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">TypeDecoder</a>&lt;<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>buffer</code> - The buffer that contains the encoded type.</dd>
<dd><code>state</code> - The decoder state.</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 while skipping the value.</dd>
</dl>
</li>
</ul>
<a id="skipValue(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>skipValue</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;skipValue&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a>&nbsp;stream,
<a href="../../StreamDecoderState.html" title="interface in org.apache.qpid.protonj2.codec">StreamDecoderState</a>&nbsp;state)
throws <a href="../../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../StreamTypeDecoder.html#skipValue(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState)">StreamTypeDecoder</a></code></span></div>
<div class="block">Skips over the bytes that compose the type this descriptor decodes.
<p>
Skipping values can be used when the type is not used or processed by the
application doing the decoding. An example might be an AMQP message decoder
that only needs to decode certain parts of the message and not others.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../StreamTypeDecoder.html#skipValue(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState)">skipValue</a></code>&nbsp;in interface&nbsp;<code><a href="../../StreamTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">StreamTypeDecoder</a>&lt;<a href="../../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stream</code> - The stream that contains the encoded type.</dd>
<dd><code>state</code> - The decoder state.</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 while skipping the value.</dd>
</dl>
</li>
</ul>
<a id="readSize(org.apache.qpid.protonj2.buffer.ProtonBuffer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readSize</h4>
<pre class="methodSignature">protected abstract&nbsp;int&nbsp;readSize&#8203;(<a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a>&nbsp;buffer)
throws <a href="../../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></pre>
<div class="block">Subclasses must read the correct number of bytes from the buffer to determine the
size of the encoded Symbol value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>buffer</code> - The buffer to read the size from.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of bytes that make up the encoded Symbol value.</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 the size value.</dd>
</dl>
</li>
</ul>
<a id="readSize(java.io.InputStream)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>readSize</h4>
<pre class="methodSignature">protected abstract&nbsp;int&nbsp;readSize&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a>&nbsp;stream)
throws <a href="../../DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></pre>
<div class="block">Subclasses must read the correct number of bytes from the buffer to determine the
size of the encoded Symbol value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stream</code> - The InputStream to read the size from.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of bytes that make up the encoded Symbol value.</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 the size value.</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/AbstractSymbolTypeDecoder.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="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>