blob: 3864271295d8532e2dcff4849d637dfe7bd1b926 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>AbstractCursor (Apache Calcite Avatica API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AbstractCursor (Apache Calcite Avatica API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":6,"i4":6,"i5":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/AbstractCursor.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" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</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>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.calcite.avatica.util</a></div>
<h2 title="Class AbstractCursor" class="title">Class AbstractCursor</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.calcite.avatica.util.AbstractCursor</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.lang.AutoCloseable</code>, <code><a href="Cursor.html" title="interface in org.apache.calcite.avatica.util">Cursor</a></code></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="PositionedCursor.html" title="class in org.apache.calcite.avatica.util">PositionedCursor</a></code></dd>
</dl>
<hr>
<pre>public abstract class <span class="typeNameLabel">AbstractCursor</span>
extends java.lang.Object
implements <a href="Cursor.html" title="interface in org.apache.calcite.avatica.util">Cursor</a></pre>
<div class="block">Base class for implementing a cursor.
<p>Derived class needs to provide <a href="AbstractCursor.Getter.html" title="interface in org.apache.calcite.avatica.util"><code>AbstractCursor.Getter</code></a> and can override
<a href="Cursor.Accessor.html" title="interface in org.apache.calcite.avatica.util"><code>Cursor.Accessor</code></a> implementations if it
wishes.</p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AbstractCursor.AbstractGetter.html" title="class in org.apache.calcite.avatica.util">AbstractCursor.AbstractGetter</a></span></code></th>
<td class="colLast">
<div class="block">Abstract implementation of <a href="AbstractCursor.Getter.html" title="interface in org.apache.calcite.avatica.util"><code>AbstractCursor.Getter</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AbstractCursor.ArrayAccessor.html" title="class in org.apache.calcite.avatica.util">AbstractCursor.ArrayAccessor</a></span></code></th>
<td class="colLast">
<div class="block">Accessor that assumes that the underlying value is an ARRAY;
corresponds to <code>Types.ARRAY</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AbstractCursor.Getter.html" title="interface in org.apache.calcite.avatica.util">AbstractCursor.Getter</a></span></code></th>
<td class="colLast">
<div class="block">Gets a value from a particular field of the current record of this
cursor.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AbstractCursor.SlotGetter.html" title="class in org.apache.calcite.avatica.util">AbstractCursor.SlotGetter</a></span></code></th>
<td class="colLast">
<div class="block">Implementation of <a href="AbstractCursor.Getter.html" title="interface in org.apache.calcite.avatica.util"><code>AbstractCursor.Getter</code></a> that returns the current contents of
a mutable slot.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AbstractCursor.StructGetter.html" title="class in org.apache.calcite.avatica.util">AbstractCursor.StructGetter</a></span></code></th>
<td class="colLast">
<div class="block">Implementation of <a href="AbstractCursor.Getter.html" title="interface in org.apache.calcite.avatica.util"><code>AbstractCursor.Getter</code></a> that returns the value of a given field
of the current contents of another getter.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.apache.calcite.avatica.util.Cursor">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.calcite.avatica.util.<a href="Cursor.html" title="interface in org.apache.calcite.avatica.util">Cursor</a></h3>
<code><a href="Cursor.Accessor.html" title="interface in org.apache.calcite.avatica.util">Cursor.Accessor</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#wasNull">wasNull</a></span></code></th>
<td class="colLast">
<div class="block">Slot into which each accessor should write whether the
value returned was null.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colSecond" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">AbstractCursor</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<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><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected <a href="Cursor.Accessor.html" title="interface in org.apache.calcite.avatica.util">Cursor.Accessor</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createAccessor(org.apache.calcite.avatica.ColumnMetaData,int,java.util.Calendar,org.apache.calcite.avatica.util.ArrayImpl.Factory)">createAccessor</a></span>&#8203;(<a href="../ColumnMetaData.html" title="class in org.apache.calcite.avatica">ColumnMetaData</a>&nbsp;columnMetaData,
int&nbsp;ordinal,
java.util.Calendar&nbsp;localCalendar,
<a href="ArrayImpl.Factory.html" title="interface in org.apache.calcite.avatica.util">ArrayImpl.Factory</a>&nbsp;factory)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected <a href="Cursor.Accessor.html" title="interface in org.apache.calcite.avatica.util">Cursor.Accessor</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createAccessor(org.apache.calcite.avatica.ColumnMetaData,org.apache.calcite.avatica.util.AbstractCursor.Getter,java.util.Calendar,org.apache.calcite.avatica.util.ArrayImpl.Factory)">createAccessor</a></span>&#8203;(<a href="../ColumnMetaData.html" title="class in org.apache.calcite.avatica">ColumnMetaData</a>&nbsp;columnMetaData,
<a href="AbstractCursor.Getter.html" title="interface in org.apache.calcite.avatica.util">AbstractCursor.Getter</a>&nbsp;getter,
java.util.Calendar&nbsp;localCalendar,
<a href="ArrayImpl.Factory.html" title="interface in org.apache.calcite.avatica.util">ArrayImpl.Factory</a>&nbsp;factory)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="Cursor.Accessor.html" title="interface in org.apache.calcite.avatica.util">Cursor.Accessor</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createAccessors(java.util.List,java.util.Calendar,org.apache.calcite.avatica.util.ArrayImpl.Factory)">createAccessors</a></span>&#8203;(java.util.List&lt;<a href="../ColumnMetaData.html" title="class in org.apache.calcite.avatica">ColumnMetaData</a>&gt;&nbsp;types,
java.util.Calendar&nbsp;localCalendar,
<a href="ArrayImpl.Factory.html" title="interface in org.apache.calcite.avatica.util">ArrayImpl.Factory</a>&nbsp;factory)</code></th>
<td class="colLast">
<div class="block">Creates a list of accessors, one per column.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected abstract <a href="AbstractCursor.Getter.html" title="interface in org.apache.calcite.avatica.util">AbstractCursor.Getter</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createGetter(int)">createGetter</a></span>&#8203;(int&nbsp;ordinal)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>abstract boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#next()">next</a></span>()</code></th>
<td class="colLast">
<div class="block">Moves to the next row.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#wasNull()">wasNull</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns whether the last value returned was null.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.calcite.avatica.util.Cursor">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.calcite.avatica.util.<a href="Cursor.html" title="interface in org.apache.calcite.avatica.util">Cursor</a></h3>
<code><a href="Cursor.html#close()">close</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="wasNull">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>wasNull</h4>
<pre>protected final&nbsp;boolean[] wasNull</pre>
<div class="block">Slot into which each accessor should write whether the
value returned was null.</div>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractCursor</h4>
<pre>protected&nbsp;AbstractCursor()</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="wasNull()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>wasNull</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;wasNull()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="Cursor.html#wasNull()">Cursor</a></code></span></div>
<div class="block">Returns whether the last value returned was null.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Cursor.html#wasNull()">wasNull</a></code>&nbsp;in interface&nbsp;<code><a href="Cursor.html" title="interface in org.apache.calcite.avatica.util">Cursor</a></code></dd>
</dl>
</li>
</ul>
<a id="createAccessors(java.util.List,java.util.Calendar,org.apache.calcite.avatica.util.ArrayImpl.Factory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createAccessors</h4>
<pre class="methodSignature">public&nbsp;java.util.List&lt;<a href="Cursor.Accessor.html" title="interface in org.apache.calcite.avatica.util">Cursor.Accessor</a>&gt;&nbsp;createAccessors&#8203;(java.util.List&lt;<a href="../ColumnMetaData.html" title="class in org.apache.calcite.avatica">ColumnMetaData</a>&gt;&nbsp;types,
java.util.Calendar&nbsp;localCalendar,
<a href="ArrayImpl.Factory.html" title="interface in org.apache.calcite.avatica.util">ArrayImpl.Factory</a>&nbsp;factory)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="Cursor.html#createAccessors(java.util.List,java.util.Calendar,org.apache.calcite.avatica.util.ArrayImpl.Factory)">Cursor</a></code></span></div>
<div class="block">Creates a list of accessors, one per column.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Cursor.html#createAccessors(java.util.List,java.util.Calendar,org.apache.calcite.avatica.util.ArrayImpl.Factory)">createAccessors</a></code>&nbsp;in interface&nbsp;<code><a href="Cursor.html" title="interface in org.apache.calcite.avatica.util">Cursor</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>types</code> - List of column types, per <code>Types</code>.</dd>
<dd><code>localCalendar</code> - Calendar in local time zone</dd>
<dd><code>factory</code> - Factory that creates sub-ResultSets when needed</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>List of column accessors</dd>
</dl>
</li>
</ul>
<a id="createAccessor(org.apache.calcite.avatica.ColumnMetaData,int,java.util.Calendar,org.apache.calcite.avatica.util.ArrayImpl.Factory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createAccessor</h4>
<pre class="methodSignature">protected&nbsp;<a href="Cursor.Accessor.html" title="interface in org.apache.calcite.avatica.util">Cursor.Accessor</a>&nbsp;createAccessor&#8203;(<a href="../ColumnMetaData.html" title="class in org.apache.calcite.avatica">ColumnMetaData</a>&nbsp;columnMetaData,
int&nbsp;ordinal,
java.util.Calendar&nbsp;localCalendar,
<a href="ArrayImpl.Factory.html" title="interface in org.apache.calcite.avatica.util">ArrayImpl.Factory</a>&nbsp;factory)</pre>
</li>
</ul>
<a id="createAccessor(org.apache.calcite.avatica.ColumnMetaData,org.apache.calcite.avatica.util.AbstractCursor.Getter,java.util.Calendar,org.apache.calcite.avatica.util.ArrayImpl.Factory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createAccessor</h4>
<pre class="methodSignature">protected&nbsp;<a href="Cursor.Accessor.html" title="interface in org.apache.calcite.avatica.util">Cursor.Accessor</a>&nbsp;createAccessor&#8203;(<a href="../ColumnMetaData.html" title="class in org.apache.calcite.avatica">ColumnMetaData</a>&nbsp;columnMetaData,
<a href="AbstractCursor.Getter.html" title="interface in org.apache.calcite.avatica.util">AbstractCursor.Getter</a>&nbsp;getter,
java.util.Calendar&nbsp;localCalendar,
<a href="ArrayImpl.Factory.html" title="interface in org.apache.calcite.avatica.util">ArrayImpl.Factory</a>&nbsp;factory)</pre>
</li>
</ul>
<a id="createGetter(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createGetter</h4>
<pre class="methodSignature">protected abstract&nbsp;<a href="AbstractCursor.Getter.html" title="interface in org.apache.calcite.avatica.util">AbstractCursor.Getter</a>&nbsp;createGetter&#8203;(int&nbsp;ordinal)</pre>
</li>
</ul>
<a id="next()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>next</h4>
<pre class="methodSignature">public abstract&nbsp;boolean&nbsp;next()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="Cursor.html#next()">Cursor</a></code></span></div>
<div class="block">Moves to the next row.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="Cursor.html#next()">next</a></code>&nbsp;in interface&nbsp;<code><a href="Cursor.html" title="interface in org.apache.calcite.avatica.util">Cursor</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Whether moved</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/AbstractCursor.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" 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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2012&#x2013;2019 <a href="https://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>