java/src/main/com/google/appengine/api/datastore/EntityCachingCriteria.java

   1 package com.google.appengine.api.datastore;
   2
   3 /**
   4  * Specifies whether the entity associated with the {@link Key} is eligible for caching.
   5  */
   6 abstract class EntityCachingCriteria {
   7
   8   /**
   9    * Returns that every entity is cacheable.
  10    */
  11   public static final EntityCachingCriteria ALL_KEYS = new EntityCachingCriteria() {
  12     @Override
  13     public boolean isCacheable(Key key) {
  14       return true;
  15     }
  16   };
  17
  18   /**
  19    * Returns whether the entity associated with the {@code key} is eligible for caching.
  20    *
  21    * @param key the entity {@link Key} to check.
  22    * @return {@code true} if the entity with the specified {@code key} is cacheable.
  23    *     {@code false} otherwise.
  24    */
  25   public abstract boolean isCacheable(Key key);
  26 }