<!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 (version 1.7.0_25) on Tue Dec 03 13:53:41 PST 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>ControllerCursor (Carbonado 1.2.3 API)</title>
<meta name="date" content="2013-12-03">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ControllerCursor (Carbonado 1.2.3 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/ControllerCursor.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-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/amazon/carbonado/cursor/ArraySortBuffer.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/amazon/carbonado/cursor/DifferenceCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/amazon/carbonado/cursor/ControllerCursor.html" target="_top">Frames</a></li>
<li><a href="ControllerCursor.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">com.amazon.carbonado.cursor</div>
<h2 title="Class ControllerCursor" class="title">Class ControllerCursor<S></h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">com.amazon.carbonado.cursor.AbstractCursor</a><S></li>
<li>
<ul class="inheritance">
<li>com.amazon.carbonado.cursor.ControllerCursor<S></li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">ControllerCursor<S></span>
extends <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a><S></pre>
<div class="block">Wraps another cursor and periodically calls a <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado"><code>controller</code></a>.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Brian S O'Neill</dd></dl>
</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <S> <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/ControllerCursor.html#apply(com.amazon.carbonado.Cursor, com.amazon.carbonado.Query.Controller)">apply</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S> source,
<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code>
<div class="block">Returns a ControllerCursor depending on whether a controller instance is
passed in or not.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/ControllerCursor.html#close()">close</a></strong>()</code>
<div class="block">Call close to release any resources being held by this cursor.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/ControllerCursor.html#hasNext()">hasNext</a></strong>()</code>
<div class="block">Returns true if this cursor has more elements.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/ControllerCursor.html" title="type parameter in ControllerCursor">S</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/ControllerCursor.html#next()">next</a></strong>()</code>
<div class="block">Returns the next element from this cursor.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.cursor.AbstractCursor">
<!-- -->
</a>
<h3>Methods inherited from class com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a></h3>
<code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection, int)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#skipNext(int)">skipNext</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList()">toList</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList(int)">toList</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="apply(com.amazon.carbonado.Cursor, com.amazon.carbonado.Query.Controller)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>apply</h4>
<pre>public static <S> <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S> apply(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S> source,
<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</pre>
<div class="block">Returns a ControllerCursor depending on whether a controller instance is
passed in or not.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if source is null</dd></dl>
</li>
</ul>
<a name="hasNext()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasNext</h4>
<pre>public boolean hasNext()
throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Cursor.html#hasNext()">Cursor</a></code></strong></div>
<div class="block">Returns true if this cursor has more elements. In other words, returns
true if <a href="../../../../com/amazon/carbonado/Cursor.html#next()"><code>next</code></a> would return an element rather than throwing
an exception.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd></dl>
</li>
</ul>
<a name="next()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>next</h4>
<pre>public <a href="../../../../com/amazon/carbonado/cursor/ControllerCursor.html" title="type parameter in ControllerCursor">S</a> next()
throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Cursor.html#next()">Cursor</a></code></strong></div>
<div class="block">Returns the next element from this cursor. This method may be called
repeatedly to iterate through the results.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd></dl>
</li>
</ul>
<a name="close()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>close</h4>
<pre>public void close()
throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Cursor.html#close()">Cursor</a></code></strong></div>
<div class="block">Call close to release any resources being held by this cursor. Further
operations on this cursor will behave as if there are no results.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/ControllerCursor.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-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/amazon/carbonado/cursor/ArraySortBuffer.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/amazon/carbonado/cursor/DifferenceCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/amazon/carbonado/cursor/ControllerCursor.html" target="_top">Frames</a></li>
<li><a href="ControllerCursor.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p>
</body>
</html>