Google Git
Sign in
apache / arrow-site / refs/heads/asf-site / . / docs / dev / java / reference / org / apache / arrow / vector / BaseIntVector.html
blob: 9d559727da7dd023b3f472ea007798779f5a9c14 [file] [log] [blame]
<!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>BaseIntVector (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="BaseIntVector (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/BaseIntVector.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/vector/BaseFixedWidthVector.html" title="class in org.apache.arrow.vector"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html" title="class in org.apache.arrow.vector"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/arrow/vector/BaseIntVector.html" target="_top">Frames</a></li>
<li><a href="BaseIntVector.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&nbsp;|&nbsp;</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.vector</div>
<h2 title="Interface BaseIntVector" class="title">Interface BaseIntVector</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<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>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<a href="../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a>&gt;, <a href="../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/arrow/vector/BigIntVector.html" title="class in org.apache.arrow.vector">BigIntVector</a>, <a href="../../../../org/apache/arrow/vector/IntVector.html" title="class in org.apache.arrow.vector">IntVector</a>, <a href="../../../../org/apache/arrow/vector/SmallIntVector.html" title="class in org.apache.arrow.vector">SmallIntVector</a>, <a href="../../../../org/apache/arrow/vector/TinyIntVector.html" title="class in org.apache.arrow.vector">TinyIntVector</a>, <a href="../../../../org/apache/arrow/vector/UInt1Vector.html" title="class in org.apache.arrow.vector">UInt1Vector</a>, <a href="../../../../org/apache/arrow/vector/UInt2Vector.html" title="class in org.apache.arrow.vector">UInt2Vector</a>, <a href="../../../../org/apache/arrow/vector/UInt4Vector.html" title="class in org.apache.arrow.vector">UInt4Vector</a>, <a href="../../../../org/apache/arrow/vector/UInt8Vector.html" title="class in org.apache.arrow.vector">UInt8Vector</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">BaseIntVector</span>
extends <a href="../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a></pre>
<div class="block">Interface for all int type vectors.</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">&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></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>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/vector/BaseIntVector.html#getValueAsLong-int-">getValueAsLong</a></span>(int&nbsp;index)</code>
<div class="block">Gets the value at index.</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/vector/BaseIntVector.html#setUnsafeWithPossibleTruncate-int-long-">setUnsafeWithPossibleTruncate</a></span>(int&nbsp;index,
long&nbsp;value)</code>
<div class="block">Sets the value at index, note this value may need to be truncated.</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/vector/BaseIntVector.html#setWithPossibleTruncate-int-long-">setWithPossibleTruncate</a></span>(int&nbsp;index,
long&nbsp;value)</code>
<div class="block">Sets the value at index, note this value may need to be truncated.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.arrow.vector.FieldVector">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.arrow.vector.<a href="../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a></h3>
<code><a href="../../../../org/apache/arrow/vector/FieldVector.html#exportBuffer-org.apache.arrow.memory.ArrowBuf-java.util.List-org.apache.arrow.memory.ArrowBuf-long-boolean-">exportBuffer</a>, <a href="../../../../org/apache/arrow/vector/FieldVector.html#exportCDataBuffers-java.util.List-org.apache.arrow.memory.ArrowBuf-long-">exportCDataBuffers</a>, <a href="../../../../org/apache/arrow/vector/FieldVector.html#getChildrenFromFields--">getChildrenFromFields</a>, <a href="../../../../org/apache/arrow/vector/FieldVector.html#getDataBufferAddress--">getDataBufferAddress</a>, <a href="../../../../org/apache/arrow/vector/FieldVector.html#getFieldBuffers--">getFieldBuffers</a>, <a href="../../../../org/apache/arrow/vector/FieldVector.html#getFieldInnerVectors--">getFieldInnerVectors</a>, <a href="../../../../org/apache/arrow/vector/FieldVector.html#getOffsetBufferAddress--">getOffsetBufferAddress</a>, <a href="../../../../org/apache/arrow/vector/FieldVector.html#getValidityBufferAddress--">getValidityBufferAddress</a>, <a href="../../../../org/apache/arrow/vector/FieldVector.html#initializeChildrenFromFields-java.util.List-">initializeChildrenFromFields</a>, <a href="../../../../org/apache/arrow/vector/FieldVector.html#loadFieldBuffers-org.apache.arrow.vector.ipc.message.ArrowFieldNode-java.util.List-">loadFieldBuffers</a>, <a href="../../../../org/apache/arrow/vector/FieldVector.html#setNull-int-">setNull</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.arrow.vector.ValueVector">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.arrow.vector.<a href="../../../../org/apache/arrow/vector/ValueVector.html" title="interface in org.apache.arrow.vector">ValueVector</a></h3>
<code><a href="../../../../org/apache/arrow/vector/ValueVector.html#accept-org.apache.arrow.vector.compare.VectorVisitor-IN-">accept</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#allocateNew--">allocateNew</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#allocateNewSafe--">allocateNewSafe</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#clear--">clear</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#close--">close</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#copyFrom-int-int-org.apache.arrow.vector.ValueVector-">copyFrom</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#copyFromSafe-int-int-org.apache.arrow.vector.ValueVector-">copyFromSafe</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getAllocator--">getAllocator</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getBuffers-boolean-">getBuffers</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getBufferSize--">getBufferSize</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getBufferSizeFor-int-">getBufferSizeFor</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getDataBuffer--">getDataBuffer</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getField--">getField</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getMinorType--">getMinorType</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getName--">getName</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getNullCount--">getNullCount</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getObject-int-">getObject</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getOffsetBuffer--">getOffsetBuffer</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getReader--">getReader</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getTransferPair-org.apache.arrow.memory.BufferAllocator-">getTransferPair</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getTransferPair-org.apache.arrow.vector.types.pojo.Field-org.apache.arrow.memory.BufferAllocator-">getTransferPair</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getTransferPair-org.apache.arrow.vector.types.pojo.Field-org.apache.arrow.memory.BufferAllocator-org.apache.arrow.vector.util.CallBack-">getTransferPair</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getTransferPair-java.lang.String-org.apache.arrow.memory.BufferAllocator-">getTransferPair</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getTransferPair-java.lang.String-org.apache.arrow.memory.BufferAllocator-org.apache.arrow.vector.util.CallBack-">getTransferPair</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getValidityBuffer--">getValidityBuffer</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getValueCapacity--">getValueCapacity</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#getValueCount--">getValueCount</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#hashCode-int-">hashCode</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#hashCode-int-org.apache.arrow.memory.util.hash.ArrowBufHasher-">hashCode</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#isNull-int-">isNull</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#makeTransferPair-org.apache.arrow.vector.ValueVector-">makeTransferPair</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#reAlloc--">reAlloc</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#reset--">reset</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#setInitialCapacity-int-">setInitialCapacity</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#setValueCount-int-">setValueCount</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#validate--">validate</a>, <a href="../../../../org/apache/arrow/vector/ValueVector.html#validateFull--">validateFull</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Iterable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#forEach-java.util.function.Consumer-" title="class or interface in java.lang">forEach</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#iterator--" title="class or interface in java.lang">iterator</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#spliterator--" title="class or interface in java.lang">spliterator</a></code></li>
</ul>
</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="setWithPossibleTruncate-int-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setWithPossibleTruncate</h4>
<pre>void&nbsp;setWithPossibleTruncate(int&nbsp;index,
long&nbsp;value)</pre>
<div class="block">Sets the value at index, note this value may need to be truncated.
Note this is safe version (i.e. call setSafe(int, ...) method in vector)</div>
</li>
</ul>
<a name="setUnsafeWithPossibleTruncate-int-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUnsafeWithPossibleTruncate</h4>
<pre>void&nbsp;setUnsafeWithPossibleTruncate(int&nbsp;index,
long&nbsp;value)</pre>
<div class="block">Sets the value at index, note this value may need to be truncated.
Note this is unsafe version (i.e. call set(int, ...) method in vector)</div>
</li>
</ul>
<a name="getValueAsLong-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getValueAsLong</h4>
<pre>long&nbsp;getValueAsLong(int&nbsp;index)</pre>
<div class="block">Gets the value at index.
This value may have been extended to long and will throw <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang"><code>NullPointerException</code></a>
if the value is null. Note null check could be turned off via <a href="../../../../org/apache/arrow/vector/NullCheckingForGet.html" title="class in org.apache.arrow.vector"><code>NullCheckingForGet</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/BaseIntVector.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/vector/BaseFixedWidthVector.html" title="class in org.apache.arrow.vector"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/arrow/vector/BaseLargeVariableWidthVector.html" title="class in org.apache.arrow.vector"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/arrow/vector/BaseIntVector.html" target="_top">Frames</a></li>
<li><a href="BaseIntVector.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&nbsp;|&nbsp;</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 &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>