java/src/main/com/google/appengine/api/search/checkers/GetRequestChecker.java

   1 // Copyright 2011 Google Inc. All Rights Reserved.
   2
   3 package com.google.appengine.api.search.checkers;
   4
   5 import com.google.appengine.api.search.SearchServicePb.ListDocumentsParams;
   6 import com.google.common.base.Strings;
   7
   8 /**
   9  * Checks values of {@link com.google.appengine.api.search.GetRequest}.
  10  *
  11  */
  12 public class GetRequestChecker {
  13   /**
  14    * The maximum number of documents which can be requested.
  15    * @deprecated From 1.7.4, use {@link SearchApiLimits#GET_RANGE_MAXIMUM_LIMIT}
  16    */
  17   @Deprecated public static final int MAXIMUM_LIMIT = 1000;
  18
  19   /**
  20    * The default number of documents requested.
  21    * @deprecated From 1.7.4, use {@link SearchApiLimits#GET_RANGE_MAXIMUM_LIMIT}
  22    */
  23   @Deprecated public static final int DEFAULT_LIMIT = 100;
  24
  25   /**
  26    * Checks whether the number of documents to return is between 0 and the
  27    * maximum.
  28    *
  29    * @param limit the maximum number of documents to return in results list
  30    * @return the checked number of documents to return
  31    * @throws IllegalArgumentException if the number of documents to return
  32    * is out of range
  33    */
  34   public static int checkLimit(int limit) {
  35     Preconditions.checkArgument(limit >= 0 && limit <= SearchApiLimits.GET_RANGE_MAXIMUM_LIMIT,
  36         String.format("The limit %d must be between 0 and %d",
  37             limit, SearchApiLimits.GET_RANGE_MAXIMUM_LIMIT));
  38     return limit;
  39   }
  40
  41   /**
  42    * Checks whether the given start document Is legal.
  43    *
  44    * @param startDocId the start ocument Id to be checked.
  45    * @return the checked start document Id.
  46    * @throws IllegalArgumentException if the start document Id is illegal.
  47    */
  48   public static String checkStartDocId(String startDocId) {
  49     if (Strings.isNullOrEmpty(startDocId)) {
  50       return startDocId;
  51     }
  52     return DocumentChecker.checkDocumentId(startDocId);
  53   }
  54
  55   /**
  56    * Checks the values of the {@link ListDocumentsParams} params.
  57    *
  58    * @param params The {@link ListDocumentsParams} to check
  59    * @return the checked params
  60    * @throws IllegalArgumentException if some of the values of params are
  61    * invalid
  62    */
  63   public static ListDocumentsParams checkListDocumentsParams(ListDocumentsParams params) {
  64     IndexChecker.checkName(params.getIndexSpec().getName());
  65     if (params.hasLimit()) {
  66       checkLimit(params.getLimit());
  67     }
  68     if (params.hasStartDocId()) {
  69       DocumentChecker.checkDocumentId(params.getStartDocId());
  70     }
  71     return params;
  72   }
  73 }