| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Consumer (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)</title> |
| <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="Consumer (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":18}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Consumer.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="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/arrow/adapter/avro/consumers/CompositeAvroConsumer.html" title="class in org.apache.arrow.adapter.avro.consumers"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/arrow/adapter/avro/consumers/SkipConsumer.html" title="class in org.apache.arrow.adapter.avro.consumers"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/arrow/adapter/avro/consumers/Consumer.html" target="_top">Frames</a></li> |
| <li><a href="Consumer.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All 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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.arrow.adapter.avro.consumers</div> |
| <h2 title="Interface Consumer" class="title">Interface Consumer<T extends <a href="../../../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a>></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - The vector within consumer or its delegate, used for partially consume purpose.</dd> |
| </dl> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../../org/apache/arrow/adapter/avro/consumers/AvroArraysConsumer.html" title="class in org.apache.arrow.adapter.avro.consumers">AvroArraysConsumer</a>, <a href="../../../../../../org/apache/arrow/adapter/avro/consumers/AvroBooleanConsumer.html" title="class in org.apache.arrow.adapter.avro.consumers">AvroBooleanConsumer</a>, <a href="../../../../../../org/apache/arrow/adapter/avro/consumers/AvroBytesConsumer.html" title="class in org.apache.arrow.adapter.avro.consumers">AvroBytesConsumer</a>, <a href="../../../../../../org/apache/arrow/adapter/avro/consumers/logical/AvroDateConsumer.html" title="class in org.apache.arrow.adapter.avro.consumers.logical">AvroDateConsumer</a>, <a href="../../../../../../org/apache/arrow/adapter/avro/consumers/logical/AvroDecimalConsumer.html" title="class in org.apache.arrow.adapter.avro.consumers.logical">AvroDecimalConsumer</a>, <a href="../../../../../../org/apache/arrow/adapter/avro/consumers/logical/AvroDecimalConsumer.BytesDecimalConsumer.html" title="class in org.apache.arrow.adapter.avro.consumers.logical">AvroDecimalConsumer.BytesDecimalConsumer</a>, <a href="../../../../../../org/apache/arrow/adapter/avro/consumers/logical/AvroDecimalConsumer.FixedDecimalConsumer.html" title="class in org.apache.arrow.adapter.avro.consumers.logical">AvroDecimalConsumer.FixedDecimalConsumer</a>, <a href="../../../../../../org/apache/arrow/adapter/avro/consumers/AvroDoubleConsumer.html" title="class in org.apache.arrow.adapter.avro.consumers">AvroDoubleConsumer</a>, <a href="../../../../../../org/apache/arrow/adapter/avro/consumers/AvroEnumConsumer.html" title="class in org.apache.arrow.adapter.avro.consumers">AvroEnumConsumer</a>, <a href="../../../../../../org/apache/arrow/adapter/avro/consumers/AvroFixedConsumer.html" title="class in org.apache.arrow.adapter.avro.consumers">AvroFixedConsumer</a>, <a href="../../../../../../org/apache/arrow/adapter/avro/consumers/AvroFloatConsumer.html" title="class in org.apache.arrow.adapter.avro.consumers">AvroFloatConsumer</a>, <a href="../../../../../../org/apache/arrow/adapter/avro/consumers/AvroIntConsumer.html" title="class in org.apache.arrow.adapter.avro.consumers">AvroIntConsumer</a>, <a href="../../../../../../org/apache/arrow/adapter/avro/consumers/AvroLongConsumer.html" title="class in org.apache.arrow.adapter.avro.consumers">AvroLongConsumer</a>, <a href="../../../../../../org/apache/arrow/adapter/avro/consumers/AvroMapConsumer.html" title="class in org.apache.arrow.adapter.avro.consumers">AvroMapConsumer</a>, <a href="../../../../../../org/apache/arrow/adapter/avro/consumers/AvroNullConsumer.html" title="class in org.apache.arrow.adapter.avro.consumers">AvroNullConsumer</a>, <a href="../../../../../../org/apache/arrow/adapter/avro/consumers/AvroStringConsumer.html" title="class in org.apache.arrow.adapter.avro.consumers">AvroStringConsumer</a>, <a href="../../../../../../org/apache/arrow/adapter/avro/consumers/AvroStructConsumer.html" title="class in org.apache.arrow.adapter.avro.consumers">AvroStructConsumer</a>, <a href="../../../../../../org/apache/arrow/adapter/avro/consumers/logical/AvroTimeMicroConsumer.html" title="class in org.apache.arrow.adapter.avro.consumers.logical">AvroTimeMicroConsumer</a>, <a href="../../../../../../org/apache/arrow/adapter/avro/consumers/logical/AvroTimeMillisConsumer.html" title="class in org.apache.arrow.adapter.avro.consumers.logical">AvroTimeMillisConsumer</a>, <a href="../../../../../../org/apache/arrow/adapter/avro/consumers/logical/AvroTimestampMicrosConsumer.html" title="class in org.apache.arrow.adapter.avro.consumers.logical">AvroTimestampMicrosConsumer</a>, <a href="../../../../../../org/apache/arrow/adapter/avro/consumers/logical/AvroTimestampMillisConsumer.html" title="class in org.apache.arrow.adapter.avro.consumers.logical">AvroTimestampMillisConsumer</a>, <a href="../../../../../../org/apache/arrow/adapter/avro/consumers/AvroUnionsConsumer.html" title="class in org.apache.arrow.adapter.avro.consumers">AvroUnionsConsumer</a>, <a href="../../../../../../org/apache/arrow/adapter/avro/consumers/BaseAvroConsumer.html" title="class in org.apache.arrow.adapter.avro.consumers">BaseAvroConsumer</a>, <a href="../../../../../../org/apache/arrow/adapter/avro/consumers/SkipConsumer.html" title="class in org.apache.arrow.adapter.avro.consumers">SkipConsumer</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Consumer<T extends <a href="../../../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a>></span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></pre> |
| <div class="block">Interface that is used to consume values from avro decoder.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/adapter/avro/consumers/Consumer.html#addNull--">addNull</a></span>()</code> |
| <div class="block">Add null value to vector by making writer position + 1.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/adapter/avro/consumers/Consumer.html#close--">close</a></span>()</code> |
| <div class="block">Close this consumer when occurs exception to avoid potential leak.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/adapter/avro/consumers/Consumer.html#consume-org.apache.avro.io.Decoder-">consume</a></span>(org.apache.avro.io.Decoder decoder)</code> |
| <div class="block">Consume a specific type value from avro decoder and write it to vector.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/adapter/avro/consumers/Consumer.html#getVector--">getVector</a></span>()</code> |
| <div class="block">Get the vector within the consumer.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/adapter/avro/consumers/Consumer.html#resetValueVector-T-">resetValueVector</a></span>(<a href="../../../../../../org/apache/arrow/adapter/avro/consumers/Consumer.html" title="type parameter in Consumer">T</a> vector)</code> |
| <div class="block">Reset the vector within consumer for partial read purpose.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/adapter/avro/consumers/Consumer.html#setPosition-int-">setPosition</a></span>(int index)</code> |
| <div class="block">Set the position to write value into vector.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/adapter/avro/consumers/Consumer.html#skippable--">skippable</a></span>()</code> |
| <div class="block">Indicates whether the consumer is type of <a href="../../../../../../org/apache/arrow/adapter/avro/consumers/SkipConsumer.html" title="class in org.apache.arrow.adapter.avro.consumers"><code>SkipConsumer</code></a>.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="consume-org.apache.avro.io.Decoder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>consume</h4> |
| <pre>void consume(org.apache.avro.io.Decoder decoder) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Consume a specific type value from avro decoder and write it to vector.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>decoder</code> - avro decoder to read data</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - on error</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addNull--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addNull</h4> |
| <pre>void addNull()</pre> |
| <div class="block">Add null value to vector by making writer position + 1.</div> |
| </li> |
| </ul> |
| <a name="setPosition-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPosition</h4> |
| <pre>void setPosition(int index)</pre> |
| <div class="block">Set the position to write value into vector.</div> |
| </li> |
| </ul> |
| <a name="getVector--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getVector</h4> |
| <pre><a href="../../../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a> getVector()</pre> |
| <div class="block">Get the vector within the consumer.</div> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>void close() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Close this consumer when occurs exception to avoid potential leak.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="resetValueVector-org.apache.arrow.vector.FieldVector-"> |
| <!-- --> |
| </a><a name="resetValueVector-T-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resetValueVector</h4> |
| <pre>boolean resetValueVector(<a href="../../../../../../org/apache/arrow/adapter/avro/consumers/Consumer.html" title="type parameter in Consumer">T</a> vector)</pre> |
| <div class="block">Reset the vector within consumer for partial read purpose.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if reset is successful, false if reset is not needed.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="skippable--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>skippable</h4> |
| <pre>default boolean skippable()</pre> |
| <div class="block">Indicates whether the consumer is type of <a href="../../../../../../org/apache/arrow/adapter/avro/consumers/SkipConsumer.html" title="class in org.apache.arrow.adapter.avro.consumers"><code>SkipConsumer</code></a>.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Consumer.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="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/arrow/adapter/avro/consumers/CompositeAvroConsumer.html" title="class in org.apache.arrow.adapter.avro.consumers"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/arrow/adapter/avro/consumers/SkipConsumer.html" title="class in org.apache.arrow.adapter.avro.consumers"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/arrow/adapter/avro/consumers/Consumer.html" target="_top">Frames</a></li> |
| <li><a href="Consumer.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All 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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |