You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cayenne.apache.org by nt...@apache.org on 2017/02/20 09:20:58 UTC

cayenne git commit: CAY-2233 Deprecate size() and clear() methods from QueryCache interface additionally deprecate EhCacheQueryCache and OSQueryCache

Repository: cayenne
Updated Branches:
  refs/heads/master 4f4ade0ee -> eb7945468


CAY-2233 Deprecate size() and clear() methods from QueryCache interface
    additionally deprecate EhCacheQueryCache and OSQueryCache


Project: http://git-wip-us.apache.org/repos/asf/cayenne/repo
Commit: http://git-wip-us.apache.org/repos/asf/cayenne/commit/eb794546
Tree: http://git-wip-us.apache.org/repos/asf/cayenne/tree/eb794546
Diff: http://git-wip-us.apache.org/repos/asf/cayenne/diff/eb794546

Branch: refs/heads/master
Commit: eb794546858923026384fe19f1a1601df7b253ea
Parents: 4f4ade0
Author: Nikita Timofeev <st...@gmail.com>
Authored: Mon Feb 20 12:20:15 2017 +0300
Committer: Nikita Timofeev <st...@gmail.com>
Committed: Mon Feb 20 12:20:15 2017 +0300

----------------------------------------------------------------------
 .../java/org/apache/cayenne/jcache/JCacheQueryCache.java  |  2 --
 .../java/org/apache/cayenne/cache/EhCacheQueryCache.java  |  4 ++++
 .../java/org/apache/cayenne/cache/NestedQueryCache.java   | 10 +++++++---
 .../main/java/org/apache/cayenne/cache/OSQueryCache.java  |  4 +++-
 .../main/java/org/apache/cayenne/cache/QueryCache.java    |  6 ++++++
 .../main/java/org/apache/cayenne/query/RefreshQuery.java  |  5 ++++-
 6 files changed, 24 insertions(+), 7 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cayenne/blob/eb794546/cayenne-jcache/src/main/java/org/apache/cayenne/jcache/JCacheQueryCache.java
----------------------------------------------------------------------
diff --git a/cayenne-jcache/src/main/java/org/apache/cayenne/jcache/JCacheQueryCache.java b/cayenne-jcache/src/main/java/org/apache/cayenne/jcache/JCacheQueryCache.java
index 88a98ca..eb25696 100644
--- a/cayenne-jcache/src/main/java/org/apache/cayenne/jcache/JCacheQueryCache.java
+++ b/cayenne-jcache/src/main/java/org/apache/cayenne/jcache/JCacheQueryCache.java
@@ -19,7 +19,6 @@
 
 package org.apache.cayenne.jcache;
 
-import java.util.Arrays;
 import java.util.List;
 import java.util.Objects;
 import java.util.concurrent.ConcurrentHashMap;
@@ -106,7 +105,6 @@ public class JCacheQueryCache implements QueryCache {
      * Returns -1 to indicate that we can't calculate the size. JCache and EhCache can potentially have a complex topology
      * that can not be meaningfully described by a single int. Use other means (like provider-specific JMX) to monitor cache.
      *
-     * @deprecated since 4.0
      * @return -1
      */
     @Override

http://git-wip-us.apache.org/repos/asf/cayenne/blob/eb794546/cayenne-server/src/main/java/org/apache/cayenne/cache/EhCacheQueryCache.java
----------------------------------------------------------------------
diff --git a/cayenne-server/src/main/java/org/apache/cayenne/cache/EhCacheQueryCache.java b/cayenne-server/src/main/java/org/apache/cayenne/cache/EhCacheQueryCache.java
index 732c7ec..3de6456 100644
--- a/cayenne-server/src/main/java/org/apache/cayenne/cache/EhCacheQueryCache.java
+++ b/cayenne-server/src/main/java/org/apache/cayenne/cache/EhCacheQueryCache.java
@@ -30,6 +30,10 @@ import net.sf.ehcache.CacheManager;
 import net.sf.ehcache.Ehcache;
 import net.sf.ehcache.Element;
 
+/**
+ * @deprecated since 4.0 please use JCacheQueryCache (provided by "cayenne-jcache" module)
+ */
+@Deprecated
 public class EhCacheQueryCache implements QueryCache {
 
     /**

http://git-wip-us.apache.org/repos/asf/cayenne/blob/eb794546/cayenne-server/src/main/java/org/apache/cayenne/cache/NestedQueryCache.java
----------------------------------------------------------------------
diff --git a/cayenne-server/src/main/java/org/apache/cayenne/cache/NestedQueryCache.java b/cayenne-server/src/main/java/org/apache/cayenne/cache/NestedQueryCache.java
index ec64aad..2a465eb 100644
--- a/cayenne-server/src/main/java/org/apache/cayenne/cache/NestedQueryCache.java
+++ b/cayenne-server/src/main/java/org/apache/cayenne/cache/NestedQueryCache.java
@@ -65,12 +65,13 @@ public class NestedQueryCache implements QueryCache {
 
     /**
      * Clears the underlying shared cache.
+     * @see QueryCache#clear()
+     * @deprecated since 4.0
      */
     @Override
+    @Deprecated
     public void clear() {
-        // seems pretty evil - it clears the keys that do not belong to our
-        // subset of the
-        // cache
+        // seems pretty evil - it clears the keys that do not belong to our subset of the cache
         delegate.clear();
     }
 
@@ -110,8 +111,11 @@ public class NestedQueryCache implements QueryCache {
 
     /**
      * Returns a shared cache size.
+     * @see QueryCache#size()
+     * @deprecated since 4.0
      */
     @Override
+    @Deprecated
     public int size() {
         return delegate.size();
     }

http://git-wip-us.apache.org/repos/asf/cayenne/blob/eb794546/cayenne-server/src/main/java/org/apache/cayenne/cache/OSQueryCache.java
----------------------------------------------------------------------
diff --git a/cayenne-server/src/main/java/org/apache/cayenne/cache/OSQueryCache.java b/cayenne-server/src/main/java/org/apache/cayenne/cache/OSQueryCache.java
index e0aa060..0d36242 100644
--- a/cayenne-server/src/main/java/org/apache/cayenne/cache/OSQueryCache.java
+++ b/cayenne-server/src/main/java/org/apache/cayenne/cache/OSQueryCache.java
@@ -65,7 +65,7 @@ import com.opensymphony.oscache.general.GeneralCacheAdministrator;
  * # expire entries every hour on the 10's minute
  * cayenne.default.cron = 10 * * * *
  *                        
- * # Same parameters can be overriden per query
+ * # Same parameters can be overridden per query
  * cayenne.group.xyz.refresh = 120
  * cayenne.group.xyz.cron = 10 1 * * *
  * </pre>
@@ -73,7 +73,9 @@ import com.opensymphony.oscache.general.GeneralCacheAdministrator;
  * Further extension of OSQueryCache is possible by using OSCache listener API.
  * 
  * @since 3.0
+ * @deprecated since 4.0 as OSCache project is abandoned
  */
+@Deprecated
 public class OSQueryCache implements QueryCache {
 
     public static final int DEFAULT_REFRESH_PERIOD = CacheEntry.INDEFINITE_EXPIRY;

http://git-wip-us.apache.org/repos/asf/cayenne/blob/eb794546/cayenne-server/src/main/java/org/apache/cayenne/cache/QueryCache.java
----------------------------------------------------------------------
diff --git a/cayenne-server/src/main/java/org/apache/cayenne/cache/QueryCache.java b/cayenne-server/src/main/java/org/apache/cayenne/cache/QueryCache.java
index 89f1040..789e2ba 100644
--- a/cayenne-server/src/main/java/org/apache/cayenne/cache/QueryCache.java
+++ b/cayenne-server/src/main/java/org/apache/cayenne/cache/QueryCache.java
@@ -75,12 +75,18 @@ public interface QueryCache {
 
     /**
      * Clears all cache entries.
+     *
+     * @deprecated since 4.0. Please use implementation specific methods to perform cache management tasks.
      */
+    @Deprecated
     void clear();
 
     /**
      * Returns the number of entries currently in the cache, including expired but not
      * removed entries.
+     *
+     * @deprecated since 4.0. Please use implementation specific methods to perform cache management tasks.
      */
+    @Deprecated
     int size();
 }

http://git-wip-us.apache.org/repos/asf/cayenne/blob/eb794546/cayenne-server/src/main/java/org/apache/cayenne/query/RefreshQuery.java
----------------------------------------------------------------------
diff --git a/cayenne-server/src/main/java/org/apache/cayenne/query/RefreshQuery.java b/cayenne-server/src/main/java/org/apache/cayenne/query/RefreshQuery.java
index c31ce92..72c3597 100644
--- a/cayenne-server/src/main/java/org/apache/cayenne/query/RefreshQuery.java
+++ b/cayenne-server/src/main/java/org/apache/cayenne/query/RefreshQuery.java
@@ -23,7 +23,6 @@ import java.util.Collection;
 
 import org.apache.cayenne.CayenneRuntimeException;
 import org.apache.cayenne.Persistent;
-import org.apache.cayenne.configuration.ConfigurationNodeVisitor;
 import org.apache.cayenne.map.DataMap;
 import org.apache.cayenne.map.EntityResolver;
 
@@ -42,7 +41,11 @@ public class RefreshQuery implements Query {
     /**
      * Creates a RefreshQuery that does full refresh of all registered objects, cascading
      * refresh all the way to the shared cache.
+     *
+     * @deprecated since 4.0, "refresh all" query will drop all cache contents
+     * @see org.apache.cayenne.cache.QueryCache#clear()
      */
+    @Deprecated
     public RefreshQuery() {
 
     }