<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!--NewPage--> <HTML> <HEAD> <!-- Generated by javadoc (build 1.6.0-google-v3) on Tue Jun 14 18:16:22 PDT 2011 --> <TITLE> FetchOptions </TITLE> <META NAME="date" CONTENT="2011-06-14"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../dev_javadoc.css" TITLE="Style"> <SCRIPT type="text/javascript"> function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="FetchOptions"; } } </SCRIPT> <NOSCRIPT> </NOSCRIPT> </HEAD> <BODY BGCOLOR="white" onload="windowTitle();"> <HR> <!-- ========= START OF TOP NAVBAR ======= --> <A NAME="navbar_top"><!-- --></A> <A HREF="#skip-navbar_top" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_top_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../com/google/appengine/api/datastore/EntityTranslator.html" title="class in com.google.appengine.api.datastore"><B>PREV CLASS</B></A> <A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.Builder.html" title="class in com.google.appengine.api.datastore"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../index.html?com/google/appengine/api/datastore/FetchOptions.html" target="_top"><B>FRAMES</B></A> <A HREF="FetchOptions.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_top"></A> <!-- ========= END OF TOP NAVBAR ========= --> <HR> <!-- ======== START OF CLASS DATA ======== --> <H2> <FONT SIZE="-1"> com.google.appengine.api.datastore</FONT> <BR> Class FetchOptions</H2> <PRE> java.lang.Object <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.google.appengine.api.datastore.FetchOptions</B> </PRE> <HR> <DL> <DT><PRE>public final class <B>FetchOptions</B><DT>extends java.lang.Object</DL> </PRE> <P> Describes the limit, offset, and chunk size to be applied when executing a <A HREF="../../../../../com/google/appengine/api/datastore/PreparedQuery.html" title="interface in com.google.appengine.api.datastore"><CODE>PreparedQuery</CODE></A>. <p> <code>limit</code> is the maximum number of results the query will return. <p> <code>offset</code> is the number of results to skip before returning any results. Results that are skipped due to offset do not count against <code>limit</code>. <p> <code>startCursor</code> and <code>endCursor</code> are previously generated cursors that point to locations in a result set. If specified queries will start and end at these locations. <p> <code>prefetchSize</code> is the number of results retrieved on the first call to the datastore. <p> <code>chunkSize</code> determines the internal chunking strategy of the <CODE>Iterator</CODE> returned by <A HREF="../../../../../com/google/appengine/api/datastore/PreparedQuery.html#asIterator(com.google.appengine.api.datastore.FetchOptions)"><CODE>PreparedQuery.asIterator(FetchOptions)</CODE></A> and the <CODE>Iterable</CODE> returned by <A HREF="../../../../../com/google/appengine/api/datastore/PreparedQuery.html#asIterable(com.google.appengine.api.datastore.FetchOptions)"><CODE>PreparedQuery.asIterable(FetchOptions)</CODE></A>. <p> Note that unlike <code>limit</code>, <code>offset</code> and <code>cursor</code>, <code>prefetchSize</code> and <code>chunkSize</code> have no impact on the result of the <A HREF="../../../../../com/google/appengine/api/datastore/PreparedQuery.html" title="interface in com.google.appengine.api.datastore"><CODE>PreparedQuery</CODE></A>, but rather only the performance of the <A HREF="../../../../../com/google/appengine/api/datastore/PreparedQuery.html" title="interface in com.google.appengine.api.datastore"><CODE>PreparedQuery</CODE></A>. <p> Notes on usage:<br> The recommended way to instantiate a <code>FetchOptions</code> object is to statically import <A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.Builder.html" title="class in com.google.appengine.api.datastore"><CODE>FetchOptions.Builder</CODE></A>.* and invoke a static creation method followed by an instance mutator (if needed): <blockquote> <pre> import static com.google.appengine.api.datastore.FetchOptions.Builder.*; ... // limit 10 datastoreService.prepare(query).asList(withLimit(10)); // limit 10, offset 5 datastoreService.prepare(query).asList(withLimit(10).offset(5)); </pre> </blockquote> <P> <P> <HR> <P> <!-- ======== NESTED CLASS SUMMARY ======== --> <A NAME="nested_class_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Nested Class Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static class</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.Builder.html" title="class in com.google.appengine.api.datastore">FetchOptions.Builder</A></B></CODE> <BR> Contains static creation methods for <A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html" title="class in com.google.appengine.api.datastore"><CODE>FetchOptions</CODE></A>.</TD> </TR> </TABLE> <!-- =========== FIELD SUMMARY =========== --> <A NAME="field_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Field Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html#DEFAULT_CHUNK_SIZE">DEFAULT_CHUNK_SIZE</A></B></CODE> <BR> <B>Deprecated.</B> <I>Instead of using DEFAULT_CHUNK_SIZE, do not specify a chunk size.</I></TD> </TR> </TABLE> <!-- ========== METHOD SUMMARY =========== --> <A NAME="method_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Method Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html" title="class in com.google.appengine.api.datastore">FetchOptions</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html#chunkSize(int)">chunkSize</A></B>(int chunkSize)</CODE> <BR> Sets the chunk size.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html" title="class in com.google.appengine.api.datastore">FetchOptions</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html#cursor(com.google.appengine.api.datastore.Cursor)">cursor</A></B>(<A HREF="../../../../../com/google/appengine/api/datastore/Cursor.html" title="class in com.google.appengine.api.datastore">Cursor</A> cursor)</CODE> <BR> <B>Deprecated.</B> <I>use <A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html#startCursor"><CODE>startCursor</CODE></A> instead.</I></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html" title="class in com.google.appengine.api.datastore">FetchOptions</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html#endCursor(com.google.appengine.api.datastore.Cursor)">endCursor</A></B>(<A HREF="../../../../../com/google/appengine/api/datastore/Cursor.html" title="class in com.google.appengine.api.datastore">Cursor</A> endCursor)</CODE> <BR> Sets the cursor at which to end the query.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object obj)</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.Integer</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html#getChunkSize()">getChunkSize</A></B>()</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../com/google/appengine/api/datastore/Cursor.html" title="class in com.google.appengine.api.datastore">Cursor</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html#getCursor()">getCursor</A></B>()</CODE> <BR> <B>Deprecated.</B> <I>use <A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html#getStartCursor()"><CODE>getStartCursor()</CODE></A> instead</I></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../com/google/appengine/api/datastore/Cursor.html" title="class in com.google.appengine.api.datastore">Cursor</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html#getEndCursor()">getEndCursor</A></B>()</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.Integer</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html#getLimit()">getLimit</A></B>()</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.Integer</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html#getOffset()">getOffset</A></B>()</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.Integer</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html#getPrefetchSize()">getPrefetchSize</A></B>()</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../com/google/appengine/api/datastore/Cursor.html" title="class in com.google.appengine.api.datastore">Cursor</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html#getStartCursor()">getStartCursor</A></B>()</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html#hashCode()">hashCode</A></B>()</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html" title="class in com.google.appengine.api.datastore">FetchOptions</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html#limit(int)">limit</A></B>(int limit)</CODE> <BR> Sets the limit.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html" title="class in com.google.appengine.api.datastore">FetchOptions</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html#offset(int)">offset</A></B>(int offset)</CODE> <BR> Sets the offset.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html" title="class in com.google.appengine.api.datastore">FetchOptions</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html#prefetchSize(int)">prefetchSize</A></B>(int prefetchSize)</CODE> <BR> Sets the number of entities to prefetch.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html" title="class in com.google.appengine.api.datastore">FetchOptions</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html#startCursor(com.google.appengine.api.datastore.Cursor)">startCursor</A></B>(<A HREF="../../../../../com/google/appengine/api/datastore/Cursor.html" title="class in com.google.appengine.api.datastore">Cursor</A> startCursor)</CODE> <BR> Sets the cursor at which to start the query.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html#toString()">toString</A></B>()</CODE> <BR> </TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE>getClass, notify, notifyAll, wait, wait, wait</CODE></TD> </TR> </TABLE> <P> <!-- ============ FIELD DETAIL =========== --> <A NAME="field_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Field Detail</B></FONT></TH> </TR> </TABLE> <A NAME="DEFAULT_CHUNK_SIZE"><!-- --></A><H3> DEFAULT_CHUNK_SIZE</H3> <PRE> <FONT SIZE="-1">@Deprecated </FONT>public static final int <B>DEFAULT_CHUNK_SIZE</B></PRE> <DL> <DD><B>Deprecated.</B> <I>Instead of using DEFAULT_CHUNK_SIZE, do not specify a chunk size.</I><DL> <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.google.appengine.api.datastore.FetchOptions.DEFAULT_CHUNK_SIZE">Constant Field Values</A></DL> </DL> <!-- ============ METHOD DETAIL ========== --> <A NAME="method_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Method Detail</B></FONT></TH> </TR> </TABLE> <A NAME="limit(int)"><!-- --></A><H3> limit</H3> <PRE> public <A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html" title="class in com.google.appengine.api.datastore">FetchOptions</A> <B>limit</B>(int limit)</PRE> <DL> <DD>Sets the limit. Please read the class javadoc for an explanation of how limit is used. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>limit</CODE> - The limit to set. Must be non-negative. <DT><B>Returns:</B><DD><code>this</code> (for chaining)</DL> </DD> </DL> <HR> <A NAME="offset(int)"><!-- --></A><H3> offset</H3> <PRE> public <A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html" title="class in com.google.appengine.api.datastore">FetchOptions</A> <B>offset</B>(int offset)</PRE> <DL> <DD>Sets the offset. Please read the class javadoc for an explanation of how offset is used. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>offset</CODE> - The offset to set. Must be 0 or greater. <DT><B>Returns:</B><DD><code>this</code> (for chaining)</DL> </DD> </DL> <HR> <A NAME="chunkSize(int)"><!-- --></A><H3> chunkSize</H3> <PRE> public <A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html" title="class in com.google.appengine.api.datastore">FetchOptions</A> <B>chunkSize</B>(int chunkSize)</PRE> <DL> <DD>Sets the chunk size. Please read the class javadoc for an explanation of how chunk size is used. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>chunkSize</CODE> - The chunk size to set. Must be greater than 0. <DT><B>Returns:</B><DD><code>this</code> (for chaining)</DL> </DD> </DL> <HR> <A NAME="prefetchSize(int)"><!-- --></A><H3> prefetchSize</H3> <PRE> public <A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html" title="class in com.google.appengine.api.datastore">FetchOptions</A> <B>prefetchSize</B>(int prefetchSize)</PRE> <DL> <DD>Sets the number of entities to prefetch. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>prefetchSize</CODE> - The prefetch size to set. Must be >= 0. <DT><B>Returns:</B><DD><code>this</code> (for chaining)</DL> </DD> </DL> <HR> <A NAME="cursor(com.google.appengine.api.datastore.Cursor)"><!-- --></A><H3> cursor</H3> <PRE> <FONT SIZE="-1">@Deprecated </FONT>public <A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html" title="class in com.google.appengine.api.datastore">FetchOptions</A> <B>cursor</B>(<A HREF="../../../../../com/google/appengine/api/datastore/Cursor.html" title="class in com.google.appengine.api.datastore">Cursor</A> cursor)</PRE> <DL> <DD><B>Deprecated.</B> <I>use <A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html#startCursor"><CODE>startCursor</CODE></A> instead.</I> <P> <DD>Sets the cursor to start the query from. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>cursor</CODE> - the cursor to set <DT><B>Returns:</B><DD><code>this</code> (for chaining)</DL> </DD> </DL> <HR> <A NAME="startCursor(com.google.appengine.api.datastore.Cursor)"><!-- --></A><H3> startCursor</H3> <PRE> public <A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html" title="class in com.google.appengine.api.datastore">FetchOptions</A> <B>startCursor</B>(<A HREF="../../../../../com/google/appengine/api/datastore/Cursor.html" title="class in com.google.appengine.api.datastore">Cursor</A> startCursor)</PRE> <DL> <DD>Sets the cursor at which to start the query. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>startCursor</CODE> - the cursor to set <DT><B>Returns:</B><DD><code>this</code> (for chaining)</DL> </DD> </DL> <HR> <A NAME="endCursor(com.google.appengine.api.datastore.Cursor)"><!-- --></A><H3> endCursor</H3> <PRE> public <A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html" title="class in com.google.appengine.api.datastore">FetchOptions</A> <B>endCursor</B>(<A HREF="../../../../../com/google/appengine/api/datastore/Cursor.html" title="class in com.google.appengine.api.datastore">Cursor</A> endCursor)</PRE> <DL> <DD>Sets the cursor at which to end the query. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>endCursor</CODE> - the cursor to set <DT><B>Returns:</B><DD><code>this</code> (for chaining)</DL> </DD> </DL> <HR> <A NAME="getLimit()"><!-- --></A><H3> getLimit</H3> <PRE> public java.lang.Integer <B>getLimit</B>()</PRE> <DL> <DD><DL> <DT><B>Returns:</B><DD>The limit, or <code>null</code> if no limit was provided.</DL> </DD> </DL> <HR> <A NAME="getOffset()"><!-- --></A><H3> getOffset</H3> <PRE> public java.lang.Integer <B>getOffset</B>()</PRE> <DL> <DD><DL> <DT><B>Returns:</B><DD>The offset, or <code>null</code> if no offset was provided.</DL> </DD> </DL> <HR> <A NAME="getChunkSize()"><!-- --></A><H3> getChunkSize</H3> <PRE> public java.lang.Integer <B>getChunkSize</B>()</PRE> <DL> <DD><DL> <DT><B>Returns:</B><DD>The chunk size, or <code>null</code> if no chunk size was provided.</DL> </DD> </DL> <HR> <A NAME="getPrefetchSize()"><!-- --></A><H3> getPrefetchSize</H3> <PRE> public java.lang.Integer <B>getPrefetchSize</B>()</PRE> <DL> <DD><DL> <DT><B>Returns:</B><DD>The prefetch size, or <code>null</code> if no prefetch size was provided.</DL> </DD> </DL> <HR> <A NAME="getCursor()"><!-- --></A><H3> getCursor</H3> <PRE> <FONT SIZE="-1">@Deprecated </FONT>public <A HREF="../../../../../com/google/appengine/api/datastore/Cursor.html" title="class in com.google.appengine.api.datastore">Cursor</A> <B>getCursor</B>()</PRE> <DL> <DD><B>Deprecated.</B> <I>use <A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.html#getStartCursor()"><CODE>getStartCursor()</CODE></A> instead</I> <P> <DD><DL> <DT><B>Returns:</B><DD>The start cursor, or <code>null</code> if no cursor was provided.</DL> </DD> </DL> <HR> <A NAME="getStartCursor()"><!-- --></A><H3> getStartCursor</H3> <PRE> public <A HREF="../../../../../com/google/appengine/api/datastore/Cursor.html" title="class in com.google.appengine.api.datastore">Cursor</A> <B>getStartCursor</B>()</PRE> <DL> <DD><DL> <DT><B>Returns:</B><DD>The start cursor, or <code>null</code> if no start cursor was provided.</DL> </DD> </DL> <HR> <A NAME="getEndCursor()"><!-- --></A><H3> getEndCursor</H3> <PRE> public <A HREF="../../../../../com/google/appengine/api/datastore/Cursor.html" title="class in com.google.appengine.api.datastore">Cursor</A> <B>getEndCursor</B>()</PRE> <DL> <DD><DL> <DT><B>Returns:</B><DD>The end cursor, or <code>null</code> if no end cursor was provided.</DL> </DD> </DL> <HR> <A NAME="hashCode()"><!-- --></A><H3> hashCode</H3> <PRE> public int <B>hashCode</B>()</PRE> <DL> <DD><DL> <DT><B>Overrides:</B><DD><CODE>hashCode</CODE> in class <CODE>java.lang.Object</CODE></DL> </DD> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="equals(java.lang.Object)"><!-- --></A><H3> equals</H3> <PRE> public boolean <B>equals</B>(java.lang.Object obj)</PRE> <DL> <DD><DL> <DT><B>Overrides:</B><DD><CODE>equals</CODE> in class <CODE>java.lang.Object</CODE></DL> </DD> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="toString()"><!-- --></A><H3> toString</H3> <PRE> public java.lang.String <B>toString</B>()</PRE> <DL> <DD><DL> <DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL> </DD> <DD><DL> </DL> </DD> </DL> <!-- ========= END OF CLASS DATA ========= --> <HR> <!-- ======= START OF BOTTOM NAVBAR ====== --> <A NAME="navbar_bottom"><!-- --></A> <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../com/google/appengine/api/datastore/EntityTranslator.html" title="class in com.google.appengine.api.datastore"><B>PREV CLASS</B></A> <A HREF="../../../../../com/google/appengine/api/datastore/FetchOptions.Builder.html" title="class in com.google.appengine.api.datastore"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../index.html?com/google/appengine/api/datastore/FetchOptions.html" target="_top"><B>FRAMES</B></A> <A HREF="FetchOptions.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> <HR> </BODY> </HTML>