java/src/main/com/google/appengine/api/memcache/IMemcacheServiceFactory.java

   1 // Copyright 2012 Google Inc. All rights reserved.
   2
   3 package com.google.appengine.api.memcache;
   4
   5 /**
   6  * The factory by which users acquire a handle to the MemcacheService.
   7  *
   8  */
   9 public interface IMemcacheServiceFactory {
  10   /**
  11    * Gets a handle to the cache service, forcing use of specific namespace.
  12    *
  13    * <p>Although there is only one actual cache, an application may make as many
  14    * {@code MemcacheService} instances as it finds convenient. If using multiple instances, note
  15    * that the error handler established with {@link MemcacheService#setErrorHandler(ErrorHandler)}
  16    * is specific to each instance.
  17    *
  18    * @param namespace if not {@code null} forces the use of {@code namespace}
  19    * for all operations in {@code MemcacheService} . If {@code namespace} is
  20    * {@code null} - created {@code MemcacheService} will use current namespace
  21    * provided by {@link com.google.appengine.api.NamespaceManager#get()}.
  22    *
  23    * @return a new {@code MemcacheService} instance.
  24    */
  25    MemcacheService getMemcacheService(String namespace);
  26
  27   /**
  28    * Similar to {@link #getMemcacheService(String)} but returns a handle to an
  29    * asynchronous version of the cache service.
  30    */
  31    AsyncMemcacheService getAsyncMemcacheService(String namespace);
  32
  33 }