java/src/main/com/google/appengine/api/search/ListResponse.java

   1 // Copyright 2011 Google Inc. All Rights Reserved.
   2
   3 package com.google.appengine.api.search;
   4
   5 import com.google.appengine.api.search.checkers.Preconditions;
   6
   7 import java.io.Serializable;
   8 import java.util.Collections;
   9 import java.util.Iterator;
  10 import java.util.List;
  11
  12 /**
  13  * Represents a result of executing a {@link ListRequest}. The
  14  * response contains a list of T.
  15  *
  16  * @param <T> The type of object to be listed from an index
  17  *
  18  */
  19 public class ListResponse<T> implements Iterable<T>, Serializable {
  20   private static final long serialVersionUID = 1189234703739911898L;
  21
  22   private final List<T> results;
  23
  24   /**
  25    * Creates a {@link ListResponse} by specifying a list of T.
  26    *
  27    * @param results a list of T returned from the index
  28    */
  29   protected ListResponse(List<T> results) {
  30     this.results = Collections.unmodifiableList(
  31         Preconditions.checkNotNull(results, "results cannot be null"));
  32   }
  33
  34   @Override
  35   public Iterator<T> iterator() {
  36     return results.iterator();
  37   }
  38
  39   /**
  40    * @return an unmodifiable list of T from the index
  41    */
  42   public List<T> getResults() {
  43     return results;
  44   }
  45
  46   @Override
  47   public String toString() {
  48     return String.format("ListResponse(results=%s)", Util.iterableToString(results, 0));
  49   }
  50 }