java/src/main/com/google/appengine/api/search/AddDocumentsResponse.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 adding a list of {@link Document} to the index. The
  14  * response contains a list of {@link OperationResult} indicating success
  15  * or not of adding each of the {@link Document Documents}, and a
  16  * list of Id of the {@link Document Documents} which are those
  17  * given in the request or allocated by the search service to those
  18  * {@link Document Documents} which do not have an Id supplied.
  19  *
  20  * @deprecated As of 1.6.5, replaced by {@link AddResponse}.
  21  */
  22 @Deprecated
  23 public class AddDocumentsResponse implements Iterable<OperationResult>, Serializable {
  24   private static final long serialVersionUID = 1189234703739911898L;
  25
  26   private final List<OperationResult> results;
  27   private final List<String> documentIds;
  28
  29   /**
  30    * Creates a {@link AddDocumentsResponse} by specifying a list of
  31    * {@link OperationResult} and a list of document ids.
  32    *
  33    * @param results a list of {@link OperationResult} that indicate the
  34    * success or not adding each {@link Document}
  35    * @param documentIds a list of Id of the {@link Document Documents}
  36    * that were requested to be added. The search service may supply Ids for
  37    * those Documents where none was supplied
  38    */
  39   AddDocumentsResponse(List<OperationResult> results,
  40       List<String> documentIds) {
  41     this.results = Collections.unmodifiableList(
  42         Preconditions.checkNotNull(results, "results cannot be null"));
  43     this.documentIds = Collections.unmodifiableList(
  44         Preconditions.checkNotNull(documentIds, "documentIds cannot be null"));
  45   }
  46
  47   @Override
  48   public Iterator<OperationResult> iterator() {
  49     return results.iterator();
  50   }
  51
  52   /**
  53    * @return an unmodifiable list of {@link OperationResult} indicating
  54    * whether each {@link Document} was added or not
  55    */
  56   public List<OperationResult> getResults() {
  57     return results;
  58   }
  59
  60   /**
  61    * @return an unmodifiable list of {@link Document} Ids
  62    */
  63   @Deprecated
  64   public List<String> getDocumentIds() {
  65     return documentIds;
  66   }
  67
  68   @Override
  69   public String toString() {
  70     return String.format("AddDocumentsResponse(results=%s, documentIds=%s)",
  71         Util.iterableToString(results, 0), Util.iterableToString(documentIds, 0));
  72   }
  73 }