| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>StreamTypeDecoder (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, interface: StreamTypeDecoder"> |
| <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/StreamTypeDecoder.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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> <a href="package-summary.html">org.apache.qpid.protonj2.codec</a></div> |
| <h1 title="Interface StreamTypeDecoder" class="title">Interface StreamTypeDecoder<V></h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>V</code> - The type that will be returned when this decoder reads a value.</dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="decoders/primitives/BinaryTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec.decoders.primitives">BinaryTypeDecoder</a></code>, <code><a href="decoders/primitives/ListTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec.decoders.primitives">ListTypeDecoder</a></code>, <code><a href="decoders/primitives/MapTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec.decoders.primitives">MapTypeDecoder</a></code>, <code><a href="decoders/PrimitiveArrayTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec.decoders">PrimitiveArrayTypeDecoder</a></code>, <code><a href="decoders/PrimitiveTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec.decoders">PrimitiveTypeDecoder</a><V></code>, <code><a href="StreamDescribedTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec">StreamDescribedTypeDecoder</a><V></code>, <code><a href="decoders/primitives/StringTypeDecoder.html" title="interface in org.apache.qpid.protonj2.codec.decoders.primitives">StringTypeDecoder</a></code>, <code><a href="decoders/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="decoders/primitives/AbstractArrayTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">AbstractArrayTypeDecoder</a></code>, <code><a href="decoders/primitives/AbstractBinaryTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">AbstractBinaryTypeDecoder</a></code>, <code><a href="decoders/AbstractDescribedListTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders">AbstractDescribedListTypeDecoder</a></code>, <code><a href="decoders/AbstractDescribedMapTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders">AbstractDescribedMapTypeDecoder</a></code>, <code><a href="decoders/AbstractDescribedTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders">AbstractDescribedTypeDecoder</a></code>, <code><a href="decoders/primitives/AbstractListTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">AbstractListTypeDecoder</a></code>, <code><a href="decoders/primitives/AbstractMapTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">AbstractMapTypeDecoder</a></code>, <code><a href="decoders/AbstractPrimitiveTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders">AbstractPrimitiveTypeDecoder</a></code>, <code><a href="decoders/primitives/AbstractStringTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">AbstractStringTypeDecoder</a></code>, <code><a href="decoders/primitives/AbstractSymbolTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">AbstractSymbolTypeDecoder</a></code>, <code><a href="decoders/messaging/AcceptedTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">AcceptedTypeDecoder</a></code>, <code><a href="decoders/messaging/AmqpSequenceTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">AmqpSequenceTypeDecoder</a></code>, <code><a href="decoders/messaging/AmqpValueTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">AmqpValueTypeDecoder</a></code>, <code><a href="decoders/messaging/ApplicationPropertiesTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">ApplicationPropertiesTypeDecoder</a></code>, <code><a href="decoders/primitives/Array32TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">Array32TypeDecoder</a></code>, <code><a href="decoders/primitives/Array8TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">Array8TypeDecoder</a></code>, <code><a href="decoders/transport/AttachTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.transport">AttachTypeDecoder</a></code>, <code><a href="decoders/transport/BeginTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.transport">BeginTypeDecoder</a></code>, <code><a href="decoders/primitives/Binary32TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">Binary32TypeDecoder</a></code>, <code><a href="decoders/primitives/Binary8TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">Binary8TypeDecoder</a></code>, <code><a href="decoders/primitives/BooleanFalseTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">BooleanFalseTypeDecoder</a></code>, <code><a href="decoders/primitives/BooleanTrueTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">BooleanTrueTypeDecoder</a></code>, <code><a href="decoders/primitives/BooleanTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">BooleanTypeDecoder</a></code>, <code><a href="decoders/primitives/ByteTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">ByteTypeDecoder</a></code>, <code><a href="decoders/primitives/CharacterTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">CharacterTypeDecoder</a></code>, <code><a href="decoders/transport/CloseTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.transport">CloseTypeDecoder</a></code>, <code><a href="decoders/transactions/CoordinatorTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.transactions">CoordinatorTypeDecoder</a></code>, <code><a href="decoders/messaging/DataTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">DataTypeDecoder</a></code>, <code><a href="decoders/primitives/Decimal128TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">Decimal128TypeDecoder</a></code>, <code><a href="decoders/primitives/Decimal32TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">Decimal32TypeDecoder</a></code>, <code><a href="decoders/primitives/Decimal64TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">Decimal64TypeDecoder</a></code>, <code><a href="decoders/transactions/DeclaredTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.transactions">DeclaredTypeDecoder</a></code>, <code><a href="decoders/transactions/DeclareTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.transactions">DeclareTypeDecoder</a></code>, <code><a href="decoders/messaging/DeleteOnCloseTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">DeleteOnCloseTypeDecoder</a></code>, <code><a href="decoders/messaging/DeleteOnNoLinksOrMessagesTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">DeleteOnNoLinksOrMessagesTypeDecoder</a></code>, <code><a href="decoders/messaging/DeleteOnNoLinksTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">DeleteOnNoLinksTypeDecoder</a></code>, <code><a href="decoders/messaging/DeleteOnNoMessagesTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">DeleteOnNoMessagesTypeDecoder</a></code>, <code><a href="decoders/messaging/DeliveryAnnotationsTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">DeliveryAnnotationsTypeDecoder</a></code>, <code><a href="decoders/transport/DetachTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.transport">DetachTypeDecoder</a></code>, <code><a href="decoders/transactions/DischargeTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.transactions">DischargeTypeDecoder</a></code>, <code><a href="decoders/transport/DispositionTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.transport">DispositionTypeDecoder</a></code>, <code><a href="decoders/primitives/DoubleTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">DoubleTypeDecoder</a></code>, <code><a href="decoders/transport/EndTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.transport">EndTypeDecoder</a></code>, <code><a href="decoders/transport/ErrorConditionTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.transport">ErrorConditionTypeDecoder</a></code>, <code><a href="decoders/primitives/FloatTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">FloatTypeDecoder</a></code>, <code><a href="decoders/transport/FlowTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.transport">FlowTypeDecoder</a></code>, <code><a href="decoders/messaging/FooterTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">FooterTypeDecoder</a></code>, <code><a href="decoders/messaging/HeaderTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">HeaderTypeDecoder</a></code>, <code><a href="decoders/primitives/Integer32TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">Integer32TypeDecoder</a></code>, <code><a href="decoders/primitives/Integer8TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">Integer8TypeDecoder</a></code>, <code><a href="decoders/primitives/List0TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">List0TypeDecoder</a></code>, <code><a href="decoders/primitives/List32TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">List32TypeDecoder</a></code>, <code><a href="decoders/primitives/List8TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">List8TypeDecoder</a></code>, <code><a href="decoders/primitives/Long8TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">Long8TypeDecoder</a></code>, <code><a href="decoders/primitives/LongTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">LongTypeDecoder</a></code>, <code><a href="decoders/primitives/Map32TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">Map32TypeDecoder</a></code>, <code><a href="decoders/primitives/Map8TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">Map8TypeDecoder</a></code>, <code><a href="decoders/messaging/MessageAnnotationsTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">MessageAnnotationsTypeDecoder</a></code>, <code><a href="decoders/messaging/ModifiedTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">ModifiedTypeDecoder</a></code>, <code><a href="decoders/primitives/NullTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">NullTypeDecoder</a></code>, <code><a href="decoders/transport/OpenTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.transport">OpenTypeDecoder</a></code>, <code><a href="decoders/messaging/PropertiesTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">PropertiesTypeDecoder</a></code>, <code><a href="decoders/messaging/ReceivedTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">ReceivedTypeDecoder</a></code>, <code><a href="decoders/messaging/RejectedTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">RejectedTypeDecoder</a></code>, <code><a href="decoders/messaging/ReleasedTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">ReleasedTypeDecoder</a></code>, <code><a href="decoders/security/SaslChallengeTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.security">SaslChallengeTypeDecoder</a></code>, <code><a href="decoders/security/SaslInitTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.security">SaslInitTypeDecoder</a></code>, <code><a href="decoders/security/SaslMechanismsTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.security">SaslMechanismsTypeDecoder</a></code>, <code><a href="decoders/security/SaslOutcomeTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.security">SaslOutcomeTypeDecoder</a></code>, <code><a href="decoders/security/SaslResponseTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.security">SaslResponseTypeDecoder</a></code>, <code><a href="decoders/primitives/ShortTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">ShortTypeDecoder</a></code>, <code><a href="decoders/messaging/SourceTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">SourceTypeDecoder</a></code>, <code><a href="decoders/primitives/String32TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">String32TypeDecoder</a></code>, <code><a href="decoders/primitives/String8TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">String8TypeDecoder</a></code>, <code><a href="decoders/primitives/Symbol32TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">Symbol32TypeDecoder</a></code>, <code><a href="decoders/primitives/Symbol8TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">Symbol8TypeDecoder</a></code>, <code><a href="decoders/messaging/TargetTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.messaging">TargetTypeDecoder</a></code>, <code><a href="decoders/primitives/TimestampTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">TimestampTypeDecoder</a></code>, <code><a href="decoders/transactions/TransactionStateTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.transactions">TransactionStateTypeDecoder</a></code>, <code><a href="decoders/transport/TransferTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.transport">TransferTypeDecoder</a></code>, <code><a href="decoders/UnknownDescribedTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders">UnknownDescribedTypeDecoder</a></code>, <code><a href="decoders/primitives/UnsignedByteTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">UnsignedByteTypeDecoder</a></code>, <code><a href="decoders/primitives/UnsignedInteger0TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">UnsignedInteger0TypeDecoder</a></code>, <code><a href="decoders/primitives/UnsignedInteger32TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">UnsignedInteger32TypeDecoder</a></code>, <code><a href="decoders/primitives/UnsignedInteger8TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">UnsignedInteger8TypeDecoder</a></code>, <code><a href="decoders/primitives/UnsignedLong0TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">UnsignedLong0TypeDecoder</a></code>, <code><a href="decoders/primitives/UnsignedLong64TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">UnsignedLong64TypeDecoder</a></code>, <code><a href="decoders/primitives/UnsignedLong8TypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">UnsignedLong8TypeDecoder</a></code>, <code><a href="decoders/primitives/UnsignedShortTypeDecoder.html" title="class in org.apache.qpid.protonj2.codec.decoders.primitives">UnsignedShortTypeDecoder</a></code>, <code><a href="decoders/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">StreamTypeDecoder<V></span></div> |
| <div class="block">Interface for an decoder of a specific AMQP Type.</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></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><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><<a href="StreamTypeDecoder.html" title="type parameter in StreamTypeDecoder">V</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getTypeClass()" class="member-name-link">getTypeClass</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </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="#isArrayType()" class="member-name-link">isArrayType</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isNull()" class="member-name-link">isNull</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </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="#isPrimitive()" class="member-name-link">isPrimitive</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="StreamTypeDecoder.html" title="type parameter in StreamTypeDecoder">V</a>[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#readArrayElements(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState,int)" class="member-name-link">readArrayElements</a><wbr>(<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">InputStream</a> stream, |
| <a href="StreamDecoderState.html" title="interface in org.apache.qpid.protonj2.codec">StreamDecoderState</a> state, |
| int count)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Reads a series of this type that have been encoded into the body of an Array type.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#readSize(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState)" class="member-name-link">readSize</a><wbr>(<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">InputStream</a> stream, |
| <a href="StreamDecoderState.html" title="interface in org.apache.qpid.protonj2.codec">StreamDecoderState</a> state)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Reads the size in bytes of the encoded primitive from the given <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> and |
| returns it.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="StreamTypeDecoder.html" title="type parameter in StreamTypeDecoder">V</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#readValue(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState)" class="member-name-link">readValue</a><wbr>(<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">InputStream</a> stream, |
| <a href="StreamDecoderState.html" title="interface in org.apache.qpid.protonj2.codec">StreamDecoderState</a> state)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Reads the next type from the given buffer and returns it.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#skipValue(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState)" class="member-name-link">skipValue</a><wbr>(<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">InputStream</a> stream, |
| <a href="StreamDecoderState.html" title="interface in org.apache.qpid.protonj2.codec">StreamDecoderState</a> state)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Skips over the bytes that compose the type this descriptor decodes.</div> |
| </div> |
| </div> |
| </div> |
| </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="getTypeClass()"> |
| <h3>getTypeClass</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><<a href="StreamTypeDecoder.html" title="type parameter in StreamTypeDecoder">V</a>></span> <span class="element-name">getTypeClass</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the Class that this decoder handles.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isPrimitive()"> |
| <h3>isPrimitive</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isPrimitive</span>()</div> |
| <dl class="notes"> |
| <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="isArrayType()"> |
| <h3>isArrayType</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isArrayType</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if the underlying type that is going to be decoded is an array type</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isNull()"> |
| <h3>isNull</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isNull</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if the underlying type is the null type meaning there are no bytes to decode.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readSize(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState)"> |
| <h3>readSize</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name">readSize</span><wbr><span class="parameters">(<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">InputStream</a> stream, |
| <a href="StreamDecoderState.html" title="interface in org.apache.qpid.protonj2.codec">StreamDecoderState</a> state)</span></div> |
| <div class="block">Reads the size in bytes of the encoded primitive from the given <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> and |
| returns it. Since this methods advances the read position of the provided stream the |
| caller must either reset that based on a previous mark or they must read the primitive |
| payload manually as the decoder would not be able to read the value as it has no |
| retained state.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>stream</code> - the source of encoded data.</dd> |
| <dd><code>state</code> - the current state of the decoder.</dd> |
| <dt>Returns:</dt> |
| <dd>the size in bytes of the encoded primitive value.</dd> |
| <dt>Throws:</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 encoded size.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readValue(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState)"> |
| <h3>readValue</h3> |
| <div class="member-signature"><span class="return-type"><a href="StreamTypeDecoder.html" title="type parameter in StreamTypeDecoder">V</a></span> <span class="element-name">readValue</span><wbr><span class="parameters">(<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">InputStream</a> stream, |
| <a href="StreamDecoderState.html" title="interface in org.apache.qpid.protonj2.codec">StreamDecoderState</a> state)</span> |
| throws <span class="exceptions"><a href="DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></span></div> |
| <div class="block">Reads the next type from the given buffer and returns it.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>stream</code> - the source of encoded data.</dd> |
| <dd><code>state</code> - the current state of the decoder.</dd> |
| <dt>Returns:</dt> |
| <dd>the next instance in the stream that this decoder handles.</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="skipValue(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState)"> |
| <h3>skipValue</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">skipValue</span><wbr><span class="parameters">(<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">InputStream</a> stream, |
| <a href="StreamDecoderState.html" title="interface in org.apache.qpid.protonj2.codec">StreamDecoderState</a> state)</span> |
| throws <span class="exceptions"><a href="DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></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 class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>stream</code> - The stream that contains the encoded type.</dd> |
| <dd><code>state</code> - The decoder state.</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readArrayElements(java.io.InputStream,org.apache.qpid.protonj2.codec.StreamDecoderState,int)"> |
| <h3>readArrayElements</h3> |
| <div class="member-signature"><span class="return-type"><a href="StreamTypeDecoder.html" title="type parameter in StreamTypeDecoder">V</a>[]</span> <span class="element-name">readArrayElements</span><wbr><span class="parameters">(<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">InputStream</a> stream, |
| <a href="StreamDecoderState.html" title="interface in org.apache.qpid.protonj2.codec">StreamDecoderState</a> state, |
| int count)</span> |
| throws <span class="exceptions"><a href="DecodeException.html" title="class in org.apache.qpid.protonj2.codec">DecodeException</a></span></div> |
| <div class="block">Reads a series of this type that have been encoded into the body of an Array type. |
| <p> |
| When encoded into an array the values are encoded in series following the identifier |
| for the type, this method is given a count of the number of instances that are encoded |
| and should read each in succession and returning them in a new array.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>stream</code> - the source of encoded data.</dd> |
| <dd><code>state</code> - the current state of the decoder.</dd> |
| <dd><code>count</code> - the number of array elements encoded in the buffer.</dd> |
| <dt>Returns:</dt> |
| <dd>the next instance in the stream that this decoder handles.</dd> |
| <dt>Throws:</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> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
