Package com.google.api.server.spi.response

Class CollectionResponse<T>

java.lang.Object

com.google.api.server.spi.response.CollectionResponse<T>

public class CollectionResponse<T>
extends Object

Collection response to be returned by an endpoint implementation method that wants to support pagination (and other metadata about returned collection in the future). Endpoint implementation method would do something like this to use it:

public CollectionResponse<Greeting> list(@Named("pageToken") String pageToken) { List<Greeting> greetings = new ArrayList<Greeting>(); // use pageToken to fill greetings with next page of items return CollectionResponse.<Greeting>builder() .setItems(greetings) .setNextPageToken("newPageToken") .build(); }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CollectionResponse.Builder<T>	Builder for CollectionResponse.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CollectionResponse(Collection<T> items, String nextPageToken)

Method Summary

Modifier and Type	Method	Description
static <T> CollectionResponse.Builder<T>	builder()
Collection<T>	getItems()
String	getNextPageToken()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CollectionResponse

protected CollectionResponse(Collection<T> items,
                             String nextPageToken)

Method Detail

builder

public static <T> CollectionResponse.Builder<T> builder()

getNextPageToken

public String getNextPageToken()

getItems

public Collection<T> getItems()