blob: 76f5bbb5e4738de5ebf732dbe5b201e6f79cd7e1 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>AbstractBinaryTypeDecoder (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="AbstractBinaryTypeDecoder (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,"i8":10,"i9":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/AbstractBinaryTypeDecoder.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 AbstractBinaryTypeDecoder" class="title">Class AbstractBinaryTypeDecoder</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/Binary.html" title="class in org.apache.qpid.protonj2.types">Binary</a>&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.qpid.protonj2.codec.decoders.primitives.AbstractBinaryTypeDecoder</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="BinaryTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec.decoders.primitives">BinaryTypeDecoder</a></code>, <code><a href="../PrimitiveTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec.decoders">PrimitiveTypeDecoder</a>&lt;<a href="../../../types/Binary.html" title="class in org.apache.qpid.protonj2.types">Binary</a>&gt;</code>, <code><a href="../../StreamTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">StreamTypeDecoder</a>&lt;<a href="../../../types/Binary.html" title="class in org.apache.qpid.protonj2.types">Binary</a>&gt;</code>, <code><a href="../../TypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">TypeDecoder</a>&lt;<a href="../../../types/Binary.html" title="class in org.apache.qpid.protonj2.types">Binary</a>&gt;</code></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="Binary32TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">Binary32TypeDecoder</a></code>, <code><a href="Binary8TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">Binary8TypeDecoder</a></code></dd>
</dl>
<hr>
<pre>public abstract class <span class="typeNameLabel">AbstractBinaryTypeDecoder</span>
extends <a href="../AbstractPrimitiveTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders">AbstractPrimitiveTypeDecoder</a>&lt;<a href="../../../types/Binary.html" title="class in org.apache.qpid.protonj2.types">Binary</a>&gt;
implements <a href="BinaryTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec.decoders.primitives">BinaryTypeDecoder</a></pre>
<div class="block">Base class for the various Binary type decoders used to read AMQP Binary values.</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()">AbstractBinaryTypeDecoder</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>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">Reads the encoded size value for the encoded binary payload and returns it.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>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">Reads the encoded size value for the encoded binary payload and returns it.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../types/Binary.html" title="class in org.apache.qpid.protonj2.types">Binary</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="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../types/Binary.html" title="class in org.apache.qpid.protonj2.types">Binary</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="i4" class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readValueAsArray(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState)">readValueAsArray</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">Read and decode an AMQP <a href="../../../types/Binary.html" title="class in org.apache.qpid.protonj2.types"><code>Binary</code></a> into a byte array instance and return it.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>byte[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readValueAsArray(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState)">readValueAsArray</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">Read and decode an AMQP <a href="../../../types/Binary.html" title="class in org.apache.qpid.protonj2.types"><code>Binary</code></a> into a byte array instance and return it.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readValueAsBuffer(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState)">readValueAsBuffer</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">Read and decode an AMQP <a href="../../../types/Binary.html" title="class in org.apache.qpid.protonj2.types"><code>Binary</code></a> into a <a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer"><code>ProtonBuffer</code></a> instance and return it.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readValueAsBuffer(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState)">readValueAsBuffer</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">Read and decode an AMQP <a href="../../../types/Binary.html" title="class in org.apache.qpid.protonj2.types"><code>Binary</code></a> into a <a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer"><code>ProtonBuffer</code></a> instance and return it.</div>
</td>
</tr>
<tr id="i8" 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="i9" 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.primitives.BinaryTypeDecoder">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.qpid.protonj2.codec.decoders.primitives.<a href="BinaryTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec.decoders.primitives">BinaryTypeDecoder</a></h3>
<code><a href="BinaryTypeDecoder.html#getTypeClass()">getTypeClass</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.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>AbstractBinaryTypeDecoder</h4>
<pre>public&nbsp;AbstractBinaryTypeDecoder()</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/Binary.html" title="class in org.apache.qpid.protonj2.types">Binary</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/Binary.html" title="class in org.apache.qpid.protonj2.types">Binary</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="readValueAsBuffer(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readValueAsBuffer</h4>
<pre class="methodSignature">public&nbsp;<a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a>&nbsp;readValueAsBuffer&#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">Read and decode an AMQP <a href="../../../types/Binary.html" title="class in org.apache.qpid.protonj2.types"><code>Binary</code></a> into a <a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer"><code>ProtonBuffer</code></a> instance and return it.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>buffer</code> - The <a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer"><code>ProtonBuffer</code></a> where the <a href="../../../types/Binary.html" title="class in org.apache.qpid.protonj2.types"><code>Binary</code></a> encoding should be read from.</dd>
<dd><code>state</code> - The <a href="../../EncoderState.html" title="interface in org.apache.qpid.protonj2.codec"><code>EncoderState</code></a> that can be used when reading the encoded value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the bytes that comprise the encoded Binary wrapped in a <a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer"><code>ProtonBuffer</code></a> instance.</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 reading the Binary value.</dd>
</dl>
</li>
</ul>
<a id="readValueAsArray(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.DecoderState)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readValueAsArray</h4>
<pre class="methodSignature">public&nbsp;byte[]&nbsp;readValueAsArray&#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">Read and decode an AMQP <a href="../../../types/Binary.html" title="class in org.apache.qpid.protonj2.types"><code>Binary</code></a> into a byte array instance and return it.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>buffer</code> - The <a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer"><code>ProtonBuffer</code></a> where the <a href="../../../types/Binary.html" title="class in org.apache.qpid.protonj2.types"><code>Binary</code></a> encoding should be read from.</dd>
<dd><code>state</code> - The <a href="../../EncoderState.html" title="interface in org.apache.qpid.protonj2.codec"><code>EncoderState</code></a> that can be used when reading the encoded value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the bytes that comprise the encoded Binary copied into a byte array instance.</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 reading the Binary value.</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/Binary.html" title="class in org.apache.qpid.protonj2.types">Binary</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/Binary.html" title="class in org.apache.qpid.protonj2.types">Binary</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="readValueAsBuffer(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readValueAsBuffer</h4>
<pre class="methodSignature">public&nbsp;<a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a>&nbsp;readValueAsBuffer&#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">Read and decode an AMQP <a href="../../../types/Binary.html" title="class in org.apache.qpid.protonj2.types"><code>Binary</code></a> into a <a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer"><code>ProtonBuffer</code></a> instance and return it.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stream</code> - The <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"><code>InputStream</code></a> where the <a href="../../../types/Binary.html" title="class in org.apache.qpid.protonj2.types"><code>Binary</code></a> encoding should be read from.</dd>
<dd><code>state</code> - The <a href="../../EncoderState.html" title="interface in org.apache.qpid.protonj2.codec"><code>EncoderState</code></a> that can be used when reading the encoded value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the bytes that comprise the encoded Binary wrapped in a <a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer"><code>ProtonBuffer</code></a> instance.</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 reading the Binary value.</dd>
</dl>
</li>
</ul>
<a id="readValueAsArray(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readValueAsArray</h4>
<pre class="methodSignature">public&nbsp;byte[]&nbsp;readValueAsArray&#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">Read and decode an AMQP <a href="../../../types/Binary.html" title="class in org.apache.qpid.protonj2.types"><code>Binary</code></a> into a byte array instance and return it.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stream</code> - The <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"><code>InputStream</code></a> where the <a href="../../../types/Binary.html" title="class in org.apache.qpid.protonj2.types"><code>Binary</code></a> encoding should be read from.</dd>
<dd><code>state</code> - The <a href="../../EncoderState.html" title="interface in org.apache.qpid.protonj2.codec"><code>EncoderState</code></a> that can be used when reading the encoded value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the bytes that comprise the encoded Binary copied into a byte array instance.</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 reading the Binary value.</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/Binary.html" title="class in org.apache.qpid.protonj2.types">Binary</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/Binary.html" title="class in org.apache.qpid.protonj2.types">Binary</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">public abstract&nbsp;int&nbsp;readSize&#8203;(<a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a>&nbsp;buffer)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="BinaryTypeDecoder.html#readSize(org.apache.qpid.protonj2.buffer.ProtonBuffer)">BinaryTypeDecoder</a></code></span></div>
<div class="block">Reads the encoded size value for the encoded binary payload and returns it. The
read is destructive and the <a href="../../TypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec"><code>TypeDecoder</code></a> read methods cannot be called after
this unless the <a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer"><code>ProtonBuffer</code></a> is reset via a position marker. This method can
be useful when the caller intends to manually read the binary payload from the given
<a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer"><code>ProtonBuffer</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="BinaryTypeDecoder.html#readSize(org.apache.qpid.protonj2.buffer.ProtonBuffer)">readSize</a></code>&nbsp;in interface&nbsp;<code><a href="BinaryTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec.decoders.primitives">BinaryTypeDecoder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>buffer</code> - the buffer from which the binary encoded size should be read.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the size of the binary payload that is encoded in the given <a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer"><code>ProtonBuffer</code></a>.</dd>
</dl>
</li>
</ul>
<a id="readSize(java.io.InputStream)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>readSize</h4>
<pre class="methodSignature">public 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)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="BinaryTypeDecoder.html#readSize(java.io.InputStream)">BinaryTypeDecoder</a></code></span></div>
<div class="block">Reads the encoded size value for the encoded binary payload and returns it. The
read is destructive and the <a href="../../TypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec"><code>TypeDecoder</code></a> read methods cannot be called after
this unless the <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"><code>InputStream</code></a> is reset via a position marker. This method can
be useful when the caller intends to manually read the binary payload from the given
<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"><code>InputStream</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="BinaryTypeDecoder.html#readSize(java.io.InputStream)">readSize</a></code>&nbsp;in interface&nbsp;<code><a href="BinaryTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec.decoders.primitives">BinaryTypeDecoder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stream</code> - the stream from which the binary encoded size should be read.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the size of the binary payload that is encoded in the given <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"><code>InputStream</code></a>.</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/AbstractBinaryTypeDecoder.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>