com.google.api.server.spi.response.CollectionResponse Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of endpoints-framework Show documentation

A framework for building RESTful web APIs.

There is a newer version: 2.2.2

/*
 * Copyright 2016 Google Inc. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.google.api.server.spi.response;

import java.util.Collection;

/**
 * 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();
 * }
 * 
 */
public class CollectionResponse {

  /**
   * Builder for {@link CollectionResponse}.
   */
  public static class Builder {

    private Collection items;
    private String nextPageToken;

    public Builder setItems(Collection items) {
      this.items = items;
      return this;
    }

    public Builder setNextPageToken(String nextPageToken) {
      this.nextPageToken = nextPageToken;
      return this;
    }

    public CollectionResponse build() {
      return new CollectionResponse(items, nextPageToken);
    }
  }

  public static  Builder builder() {
    return new Builder();
  }

  private final Collection items;
  private final String nextPageToken;

  protected CollectionResponse(Collection items, String nextPageToken) {
    this.items = items;
    this.nextPageToken = nextPageToken;
  }

  public String getNextPageToken() {
    return nextPageToken;
  }

  public Collection getItems() {
    return items;
  }
}