blob: 7ec71318b772406f9723f6a9b31a90653b5c98d8 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>PrimitiveTypeDecoder (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, interface: PrimitiveTypeDecoder">
<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/PrimitiveTypeDecoder.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.qpid.protonj2.codec.decoders</a></div>
<h1 title="Interface PrimitiveTypeDecoder" class="title">Interface PrimitiveTypeDecoder&lt;V&gt;</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>Type Parameters:</dt>
<dd><code>V</code> - the Type Class that this decoder manages.</dd>
</dl>
<dl class="notes">
<dt>All Superinterfaces:</dt>
<dd><code><a href="../StreamTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">StreamTypeDecoder</a>&lt;V&gt;</code>, <code><a href="../TypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">TypeDecoder</a>&lt;V&gt;</code></dd>
</dl>
<dl class="notes">
<dt>All Known Subinterfaces:</dt>
<dd><code><a href="primitives/BinaryTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec.decoders.primitives">BinaryTypeDecoder</a></code>, <code><a href="primitives/ListTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec.decoders.primitives">ListTypeDecoder</a></code>, <code><a href="primitives/MapTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec.decoders.primitives">MapTypeDecoder</a></code>, <code><a href="PrimitiveArrayTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec.decoders">PrimitiveArrayTypeDecoder</a></code>, <code><a href="primitives/StringTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec.decoders.primitives">StringTypeDecoder</a></code>, <code><a href="primitives/SymbolTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec.decoders.primitives">SymbolTypeDecoder</a></code></dd>
</dl>
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="primitives/AbstractArrayTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">AbstractArrayTypeDecoder</a></code>, <code><a href="primitives/AbstractBinaryTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">AbstractBinaryTypeDecoder</a></code>, <code><a href="primitives/AbstractListTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">AbstractListTypeDecoder</a></code>, <code><a href="primitives/AbstractMapTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">AbstractMapTypeDecoder</a></code>, <code><a href="AbstractPrimitiveTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders">AbstractPrimitiveTypeDecoder</a></code>, <code><a href="primitives/AbstractStringTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">AbstractStringTypeDecoder</a></code>, <code><a href="primitives/AbstractSymbolTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">AbstractSymbolTypeDecoder</a></code>, <code><a href="primitives/Array32TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">Array32TypeDecoder</a></code>, <code><a href="primitives/Array8TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">Array8TypeDecoder</a></code>, <code><a href="primitives/Binary32TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">Binary32TypeDecoder</a></code>, <code><a href="primitives/Binary8TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">Binary8TypeDecoder</a></code>, <code><a href="primitives/BooleanFalseTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">BooleanFalseTypeDecoder</a></code>, <code><a href="primitives/BooleanTrueTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">BooleanTrueTypeDecoder</a></code>, <code><a href="primitives/BooleanTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">BooleanTypeDecoder</a></code>, <code><a href="primitives/ByteTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">ByteTypeDecoder</a></code>, <code><a href="primitives/CharacterTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">CharacterTypeDecoder</a></code>, <code><a href="primitives/Decimal128TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">Decimal128TypeDecoder</a></code>, <code><a href="primitives/Decimal32TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">Decimal32TypeDecoder</a></code>, <code><a href="primitives/Decimal64TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">Decimal64TypeDecoder</a></code>, <code><a href="primitives/DoubleTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">DoubleTypeDecoder</a></code>, <code><a href="primitives/FloatTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">FloatTypeDecoder</a></code>, <code><a href="primitives/Integer32TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">Integer32TypeDecoder</a></code>, <code><a href="primitives/Integer8TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">Integer8TypeDecoder</a></code>, <code><a href="primitives/List0TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">List0TypeDecoder</a></code>, <code><a href="primitives/List32TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">List32TypeDecoder</a></code>, <code><a href="primitives/List8TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">List8TypeDecoder</a></code>, <code><a href="primitives/Long8TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">Long8TypeDecoder</a></code>, <code><a href="primitives/LongTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">LongTypeDecoder</a></code>, <code><a href="primitives/Map32TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">Map32TypeDecoder</a></code>, <code><a href="primitives/Map8TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">Map8TypeDecoder</a></code>, <code><a href="primitives/NullTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">NullTypeDecoder</a></code>, <code><a href="primitives/ShortTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">ShortTypeDecoder</a></code>, <code><a href="primitives/String32TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">String32TypeDecoder</a></code>, <code><a href="primitives/String8TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">String8TypeDecoder</a></code>, <code><a href="primitives/Symbol32TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">Symbol32TypeDecoder</a></code>, <code><a href="primitives/Symbol8TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">Symbol8TypeDecoder</a></code>, <code><a href="primitives/TimestampTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">TimestampTypeDecoder</a></code>, <code><a href="primitives/UnsignedByteTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">UnsignedByteTypeDecoder</a></code>, <code><a href="primitives/UnsignedInteger0TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">UnsignedInteger0TypeDecoder</a></code>, <code><a href="primitives/UnsignedInteger32TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">UnsignedInteger32TypeDecoder</a></code>, <code><a href="primitives/UnsignedInteger8TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">UnsignedInteger8TypeDecoder</a></code>, <code><a href="primitives/UnsignedLong0TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">UnsignedLong0TypeDecoder</a></code>, <code><a href="primitives/UnsignedLong64TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">UnsignedLong64TypeDecoder</a></code>, <code><a href="primitives/UnsignedLong8TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">UnsignedLong8TypeDecoder</a></code>, <code><a href="primitives/UnsignedShortTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">UnsignedShortTypeDecoder</a></code>, <code><a href="primitives/UUIDTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">UUIDTypeDecoder</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">PrimitiveTypeDecoder&lt;V&gt;</span><span class="extends-implements">
extends <a href="../TypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">TypeDecoder</a>&lt;V&gt;, <a href="../StreamTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">StreamTypeDecoder</a>&lt;V&gt;</span></div>
<div class="block">Interface for a TypeDecoder that manages decoding of AMQP primitive types.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getTypeCode()" class="member-name-link">getTypeCode</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isJavaPrimitive()" class="member-name-link">isJavaPrimitive</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#isPrimitive()" class="member-name-link">isPrimitive</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">&nbsp;</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.qpid.protonj2.codec.StreamTypeDecoder">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#isNull()">isNull</a>, <a href="../StreamTypeDecoder.html#readArrayElements(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState,int)">readArrayElements</a>, <a href="../StreamTypeDecoder.html#readSize(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState)">readSize</a>, <a href="../StreamTypeDecoder.html#readValue(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState)">readValue</a>, <a href="../StreamTypeDecoder.html#skipValue(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState)">skipValue</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.qpid.protonj2.codec.TypeDecoder">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#getTypeClass()">getTypeClass</a>, <a href="../TypeDecoder.html#isArrayType()">isArrayType</a>, <a href="../TypeDecoder.html#isNull()">isNull</a>, <a href="../TypeDecoder.html#readArrayElements(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState,int)">readArrayElements</a>, <a href="../TypeDecoder.html#readSize(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState)">readSize</a>, <a href="../TypeDecoder.html#readValue(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState)">readValue</a>, <a href="../TypeDecoder.html#skipValue(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState)">skipValue</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="isPrimitive()">
<h3>isPrimitive</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isPrimitive</span>()</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../StreamTypeDecoder.html#isPrimitive()">isPrimitive</a></code>&nbsp;in interface&nbsp;<code><a href="../StreamTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">StreamTypeDecoder</a>&lt;<a href="PrimitiveTypeDecoder.html" title="type parameter in PrimitiveTypeDecoder">V</a>&gt;</code></dd>
<dt>Specified by:</dt>
<dd><code><a href="../TypeDecoder.html#isPrimitive()">isPrimitive</a></code>&nbsp;in interface&nbsp;<code><a href="../TypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">TypeDecoder</a>&lt;<a href="PrimitiveTypeDecoder.html" title="type parameter in PrimitiveTypeDecoder">V</a>&gt;</code></dd>
<dt>Returns:</dt>
<dd>true if the underlying type that is going to be decoded is an primitive type</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isJavaPrimitive()">
<h3>isJavaPrimitive</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">isJavaPrimitive</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>true if the type managed by this decoder is assignable to a Java primitive type.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getTypeCode()">
<h3>getTypeCode</h3>
<div class="member-signature"><span class="return-type">int</span>&nbsp;<span class="element-name">getTypeCode</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the AMQP Encoding Code that this primitive type decoder can read.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>