#ignite-333: Fix IgniteCache javadoc.
Project: http://git-wip-us.apache.org/repos/asf/incubator-ignite/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-ignite/commit/ada58813 Tree: http://git-wip-us.apache.org/repos/asf/incubator-ignite/tree/ada58813 Diff: http://git-wip-us.apache.org/repos/asf/incubator-ignite/diff/ada58813 Branch: refs/heads/ignite-sql-tests Commit: ada58813621c82c29954d78720f36a3ce134d139 Parents: b39bfbe Author: ivasilinets <ivasilin...@gridgain.com> Authored: Fri Mar 13 12:23:20 2015 +0300 Committer: ivasilinets <ivasilin...@gridgain.com> Committed: Fri Mar 13 12:23:20 2015 +0300 ---------------------------------------------------------------------- .../java/org/apache/ignite/IgniteCache.java | 20 ++++---------------- .../processors/cache/CacheProjection.java | 11 +++++------ 2 files changed, 9 insertions(+), 22 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/ada58813/modules/core/src/main/java/org/apache/ignite/IgniteCache.java ---------------------------------------------------------------------- diff --git a/modules/core/src/main/java/org/apache/ignite/IgniteCache.java b/modules/core/src/main/java/org/apache/ignite/IgniteCache.java index 5a7c934..99a8934 100644 --- a/modules/core/src/main/java/org/apache/ignite/IgniteCache.java +++ b/modules/core/src/main/java/org/apache/ignite/IgniteCache.java @@ -380,7 +380,7 @@ public interface IgniteCache<K, V> extends javax.cache.Cache<K, V>, IgniteAsyncS @Override public void clear(); /** - * Clear key, without notifying listeners or + * Clear entry from the cache, without notifying listeners or * {@link javax.cache.integration.CacheWriter}s. * * @param key Key to clear. @@ -391,7 +391,7 @@ public interface IgniteCache<K, V> extends javax.cache.Cache<K, V>, IgniteAsyncS public void clear(K key); /** - * Clear keys, without notifying listeners or + * Clear entries from the cache, without notifying listeners or * {@link javax.cache.integration.CacheWriter}s. * * @param keys Keys to clear. @@ -405,35 +405,23 @@ public interface IgniteCache<K, V> extends javax.cache.Cache<K, V>, IgniteAsyncS * Clears an entry from this cache and swap storage only if the entry * is not currently locked, and is not participating in a transaction. * <p/> - * If {@link CacheConfiguration#isSwapEnabled()} is set to {@code true} and - * {@link CacheFlag#SKIP_SWAP} is not enabled, the evicted entries will - * also be cleared from swap. - * <p/> * Note that this operation is local as it merely clears * an entry from local cache. It does not remove entries from * remote caches or from underlying persistent storage. - * This method is not transactionally consistent. - * Transactional semantics must be guaranteed outside of Ignite. * * @param key Key to clear. */ public void localClear(K key); /** - * Clears entries from this cache and swap storage only if the entry + * Clears an entry from this cache and swap storage only if the entry * is not currently locked, and is not participating in a transaction. * <p/> - * If {@link CacheConfiguration#isSwapEnabled()} is set to {@code true} and - * {@link CacheFlag#SKIP_SWAP} is not enabled, the evicted entries will - * also be cleared from swap. - * <p/> * Note that this operation is local as it merely clears * an entry from local cache. It does not remove entries from * remote caches or from underlying persistent storage. - * This method is not transactionally consistent. - * Transactional semantics must be guaranteed outside of Ignite. * - * @param keys Set of keys to clear. + * @param keys Keys to clear. */ public void localClearAll(Set<K> keys); http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/ada58813/modules/core/src/main/java/org/apache/ignite/internal/processors/cache/CacheProjection.java ---------------------------------------------------------------------- diff --git a/modules/core/src/main/java/org/apache/ignite/internal/processors/cache/CacheProjection.java b/modules/core/src/main/java/org/apache/ignite/internal/processors/cache/CacheProjection.java index 66507f9..f268c2f 100644 --- a/modules/core/src/main/java/org/apache/ignite/internal/processors/cache/CacheProjection.java +++ b/modules/core/src/main/java/org/apache/ignite/internal/processors/cache/CacheProjection.java @@ -1265,6 +1265,9 @@ public interface CacheProjection<K, V> extends Iterable<Cache.Entry<K, V>> { * Note that this operation is local as it merely clears * an entry from local cache. It does not remove entries from * remote caches or from underlying persistent storage. + * <h2 class="header">Cache Flags</h2> + * This method is not available if any of the following flags are set on projection: + * {@link CacheFlag#READ}. * * @param keys Keys to clearLocally. * @return {@code True} if entry was successfully cleared from cache, {@code false} @@ -1275,13 +1278,11 @@ public interface CacheProjection<K, V> extends Iterable<Cache.Entry<K, V>> { /** * Clears key on all nodes that store it's data. That is, caches are cleared on remote - * nodes and local node, as opposed to {@link CacheProjection#clearLocally()} method which only + * nodes and local node, as opposed to {@link CacheProjection#clearLocally(Object)} method which only * clears local node's cache. * <p> * Ignite will make the best attempt to clear caches on all nodes. If some caches * could not be cleared, then exception will be thrown. - * <p> - * This method is identical to calling {@link #clear(long) clear(0)}. * * @param key Key to clear. * @throws IgniteCheckedException In case of cache could not be cleared on any of the nodes. @@ -1290,13 +1291,11 @@ public interface CacheProjection<K, V> extends Iterable<Cache.Entry<K, V>> { /** * Clears keys on all nodes that store it's data. That is, caches are cleared on remote - * nodes and local node, as opposed to {@link CacheProjection#clearLocally()} method which only + * nodes and local node, as opposed to {@link CacheProjection#clearLocallyAll(Set)} method which only * clears local node's cache. * <p> * Ignite will make the best attempt to clear caches on all nodes. If some caches * could not be cleared, then exception will be thrown. - * <p> - * This method is identical to calling {@link #clear(long) clear(0)}. * * @param keys Keys to clear. * @throws IgniteCheckedException In case of cache could not be cleared on any of the nodes.
