com.google.appengine.api.search
Class ListRequest.Builder

java.lang.Object
  extended by com.google.appengine.api.search.ListRequest.Builder
Enclosing class:
ListRequest

public static final class ListRequest.Builder
extends java.lang.Object

The builder of ListRequests.


Method Summary
 ListRequest build()
           
 ListRequest.Builder setIncludeStart(boolean includeStart)
          Sets whether or not to include the object whose ID is specified via the setStartId(String) method.
 ListRequest.Builder setKeysOnly(boolean keysOnly)
          Sets whether just objects containing just their key are returned, or whether the complete objects are returned.
 ListRequest.Builder setLimit(java.lang.Integer limit)
          Sets the maximum number of objects to return.
 ListRequest.Builder setStartId(java.lang.String startId)
          Sets the Id of the first object to return.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

setStartId

public ListRequest.Builder setStartId(java.lang.String startId)
Sets the Id of the first object to return. You may exclude this object by using the setIncludeStart(boolean) method.

Parameters:
startId - the Id of the first object to return
Returns:
this builder
Throws:
java.lang.IllegalArgumentException - if invalid object Id is given

setIncludeStart

public ListRequest.Builder setIncludeStart(boolean includeStart)
Sets whether or not to include the object whose ID is specified via the setStartId(String) method.

Parameters:
includeStart - whether or not to return the start index
Returns:
this builder

setLimit

public ListRequest.Builder setLimit(java.lang.Integer limit)
Sets the maximum number of objects to return.

Parameters:
limit - the maximum number of objects to return
Returns:
this builder
Throws:
java.lang.IllegalArgumentException - if negative or too large limit is given

setKeysOnly

public ListRequest.Builder setKeysOnly(boolean keysOnly)
Sets whether just objects containing just their key are returned, or whether the complete objects are returned.

Parameters:
keysOnly - whether to only return object keys
Returns:
this builder

build

public ListRequest build()
Returns:
builds and returns a brand new instance of a ListRequest using values set on this builder