blob: 6b26caba30a15bdbb51922331e7b13b44405f0d3 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>org.apache.qpid.protonj2.codec (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="org.apache.qpid.protonj2.codec (Qpid ProtonJ2 Parent 1.0.0-M9 API)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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>
<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>
<main role="main">
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.qpid.protonj2.codec</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Decoder.html" title="interface in org.apache.qpid.protonj2.codec">Decoder</a></th>
<td class="colLast">
<div class="block">Decode AMQP types from a byte stream read from a <a href="../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer"><code>ProtonBuffer</code></a> instance.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DecoderState.html" title="interface in org.apache.qpid.protonj2.codec">DecoderState</a></th>
<td class="colLast">
<div class="block">Retains state of decode either between calls or across decode iterations</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DescribedTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">DescribedTypeDecoder</a>&lt;V&gt;</th>
<td class="colLast">
<div class="block">Interface for all DescribedType decoder implementations</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DescribedTypeEncoder.html" title="interface in org.apache.qpid.protonj2.codec">DescribedTypeEncoder</a>&lt;V&gt;</th>
<td class="colLast">
<div class="block">Interface for all DescribedType encoder implementations</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Encoder.html" title="interface in org.apache.qpid.protonj2.codec">Encoder</a></th>
<td class="colLast">
<div class="block">Encode AMQP types into binary streams</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="EncoderState.html" title="interface in org.apache.qpid.protonj2.codec">EncoderState</a></th>
<td class="colLast">
<div class="block">Retains Encoder state information either between calls or across encode iterations.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="EncodingCodes.html" title="interface in org.apache.qpid.protonj2.codec">EncodingCodes</a></th>
<td class="colLast">
<div class="block">Provides a set of definitions for the byte value that indicates what the next
AMQP encoding will be when encoding or decoding AMQP types.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="StreamDecoder.html" title="interface in org.apache.qpid.protonj2.codec">StreamDecoder</a></th>
<td class="colLast">
<div class="block">Decode AMQP types from a <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> instance.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="StreamDecoderState.html" title="interface in org.apache.qpid.protonj2.codec">StreamDecoderState</a></th>
<td class="colLast">
<div class="block">Retains state of 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> based decode either between calls or across decode iterations</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="StreamDescribedTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">StreamDescribedTypeDecoder</a>&lt;V&gt;</th>
<td class="colLast">
<div class="block">Interface for all DescribedType decoder implementations</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="StreamTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">StreamTypeDecoder</a>&lt;V&gt;</th>
<td class="colLast">
<div class="block">Interface for an decoder of a specific AMQP Type.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="TypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">TypeDecoder</a>&lt;V&gt;</th>
<td class="colLast">
<div class="block">Interface for an decoder of a specific AMQP Type.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="TypeEncoder.html" title="interface in org.apache.qpid.protonj2.codec">TypeEncoder</a>&lt;V&gt;</th>
<td class="colLast">
<div class="block">Interface for an encoder of a specific AMQP Type.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="CodecFactory.html" title="class in org.apache.qpid.protonj2.codec">CodecFactory</a></th>
<td class="colLast">
<div class="block">Factory Class used to create new instances of AMQP type
Encoder and Decoder instances registered in the factory.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SectionEncoder.html" title="class in org.apache.qpid.protonj2.codec">SectionEncoder</a></th>
<td class="colLast">
<div class="block">AMQP Section type specific encoder that uses any <a href="Encoder.html" title="interface in org.apache.qpid.protonj2.codec"><code>Encoder</code></a> to
cache the specific type encoders for various section types and use them
directly instead of looking them up via calls to <a href="Encoder.html#writeObject(org.apache.qpid.protonj2.buffer.ProtonBuffer,org.apache.qpid.protonj2.codec.EncoderState,java.lang.Object)"><code>Encoder.writeObject(org.apache.qpid.protonj2.buffer.ProtonBuffer, EncoderState, Object)</code></a></div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DecodeEOFException.html" title="class in org.apache.qpid.protonj2.codec">DecodeEOFException</a></th>
<td class="colLast">
<div class="block">Exception thrown when a type decoder fails due to some unrecoverable error or
violation of AMQP type specifications for an incoming encoded byte sequence.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></th>
<td class="colLast">
<div class="block">Exception thrown when a type decoder fails due to some unrecoverable error or
violation of AMQP type specifications for an incoming encoded byte sequence.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="EncodeException.html" title="class in org.apache.qpid.protonj2.codec">EncodeException</a></th>
<td class="colLast">
<div class="block">Exception thrown when a type encoder fails due to some unrecoverable error or
violation of AMQP type specifications.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
</main>
<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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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>
<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>