blob: aafadc7542bb8f8a888ccb4d08a0abde70415a01 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>org.apache.qpid.protonj2.codec (Qpid ProtonJ2 Parent 1.0.0-M18 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.qpid.protonj2.codec">
<meta name="generator" content="javadoc/PackageWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body class="package-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 class="nav-bar-cell1-rev">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="../../../../../help-doc.html#package">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Package:&nbsp;</li>
<li>Description&nbsp;|&nbsp;</li>
<li><a href="#related-package-summary">Related Packages</a>&nbsp;|&nbsp;</li>
<li><a href="#class-summary">Classes and Interfaces</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">
<div class="header">
<h1 title="Package org.apache.qpid.protonj2.codec" class="title">Package org.apache.qpid.protonj2.codec</h1>
</div>
<hr>
<div class="package-signature">package <span class="element-name">org.apache.qpid.protonj2.codec</span></div>
<section class="summary">
<ul class="summary-list">
<li>
<div id="related-package-summary">
<div class="caption"><span>Related Packages</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="decoders/package-summary.html">org.apache.qpid.protonj2.codec.decoders</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="encoders/package-summary.html">org.apache.qpid.protonj2.codec.encoders</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
</div>
</li>
<li>
<div id="class-summary">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab5" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab5', 2)" class="table-tab">Exceptions</button></div>
<div id="class-summary.tabpanel" role="tabpanel">
<div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="CodecFactory.html" title="class in org.apache.qpid.protonj2.codec">CodecFactory</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Factory Class used to create new instances of AMQP type
Encoder and Decoder instances registered in the factory.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab5"><a href="DecodeEOFException.html" title="class in org.apache.qpid.protonj2.codec">DecodeEOFException</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab5">
<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>
</div>
<div class="col-first even-row-color class-summary class-summary-tab5"><a href="DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></div>
<div class="col-last even-row-color class-summary class-summary-tab5">
<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>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Decoder.html" title="interface in org.apache.qpid.protonj2.codec">Decoder</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<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>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="DecoderState.html" title="interface in org.apache.qpid.protonj2.codec">DecoderState</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Retains state of decode either between calls or across decode iterations</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="DescribedTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">DescribedTypeDecoder</a>&lt;V&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Interface for all DescribedType decoder implementations</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="DescribedTypeEncoder.html" title="interface in org.apache.qpid.protonj2.codec">DescribedTypeEncoder</a>&lt;V&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Interface for all DescribedType encoder implementations</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab5"><a href="EncodeException.html" title="class in org.apache.qpid.protonj2.codec">EncodeException</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab5">
<div class="block">Exception thrown when a type encoder fails due to some unrecoverable error or
violation of AMQP type specifications.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="Encoder.html" title="interface in org.apache.qpid.protonj2.codec">Encoder</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Encode AMQP types into binary streams</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="EncoderState.html" title="interface in org.apache.qpid.protonj2.codec">EncoderState</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Retains Encoder state information either between calls or across encode iterations.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="EncodingCodes.html" title="interface in org.apache.qpid.protonj2.codec">EncodingCodes</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<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>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PerformativeEncoder.html" title="class in org.apache.qpid.protonj2.codec">PerformativeEncoder</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">AMQP Performative 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>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SectionEncoder.html" title="class in org.apache.qpid.protonj2.codec">SectionEncoder</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<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>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="StreamDecoder.html" title="interface in org.apache.qpid.protonj2.codec">StreamDecoder</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<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" title="class or interface in java.io" class="external-link"><code>InputStream</code></a> instance.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="StreamDecoderState.html" title="interface in org.apache.qpid.protonj2.codec">StreamDecoderState</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<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" title="class or interface in java.io" class="external-link"><code>InputStream</code></a> based decode either between calls or across decode iterations</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="StreamDescribedTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">StreamDescribedTypeDecoder</a>&lt;V&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Interface for all DescribedType decoder implementations</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="StreamTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">StreamTypeDecoder</a>&lt;V&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Interface for an decoder of a specific AMQP Type.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="TypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">TypeDecoder</a>&lt;V&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Interface for an decoder of a specific AMQP Type.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="TypeEncoder.html" title="interface in org.apache.qpid.protonj2.codec">TypeEncoder</a>&lt;V&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Interface for an encoder of a specific AMQP Type.</div>
</div>
</div>
</div>
</div>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>