fixed javadoc ignite-1.4
Project: http://git-wip-us.apache.org/repos/asf/ignite/repo Commit: http://git-wip-us.apache.org/repos/asf/ignite/commit/72e270c6 Tree: http://git-wip-us.apache.org/repos/asf/ignite/tree/72e270c6 Diff: http://git-wip-us.apache.org/repos/asf/ignite/diff/72e270c6 Branch: refs/heads/ignite-gg-10760 Commit: 72e270c63e99ac17a077b26fb39302f603d15188 Parents: 3f75c1c Author: Yakov Zhdanov <yzhda...@gridgain.com> Authored: Tue Sep 15 16:55:00 2015 +0300 Committer: Yakov Zhdanov <yzhda...@gridgain.com> Committed: Tue Sep 15 16:55:00 2015 +0300 ---------------------------------------------------------------------- .../configuration/NearCacheConfiguration.java | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/ignite/blob/72e270c6/modules/core/src/main/java/org/apache/ignite/configuration/NearCacheConfiguration.java ---------------------------------------------------------------------- diff --git a/modules/core/src/main/java/org/apache/ignite/configuration/NearCacheConfiguration.java b/modules/core/src/main/java/org/apache/ignite/configuration/NearCacheConfiguration.java index bbaa030..3c59bd6 100644 --- a/modules/core/src/main/java/org/apache/ignite/configuration/NearCacheConfiguration.java +++ b/modules/core/src/main/java/org/apache/ignite/configuration/NearCacheConfiguration.java @@ -25,7 +25,12 @@ import org.apache.ignite.internal.util.typedef.internal.S; import static org.apache.ignite.configuration.CacheConfiguration.DFLT_NEAR_START_SIZE; /** - * Client cache configuration. + * Client (near) cache configuration. + * <p> + * Distributed cache can also be fronted by a Near cache, + * which is a smaller local cache that stores most recently + * or most frequently accessed data. Just like with a partitioned cache, + * the user can control the size of the near cache and its eviction policies. */ public class NearCacheConfiguration<K, V> extends MutableConfiguration<K, V> { /** */ @@ -45,6 +50,8 @@ public class NearCacheConfiguration<K, V> extends MutableConfiguration<K, V> { } /** + * Creates near cache configuration copying properties from passed in configuration. + * * @param ccfg Configuration to copy. */ public NearCacheConfiguration(NearCacheConfiguration<K, V> ccfg) { @@ -55,13 +62,20 @@ public class NearCacheConfiguration<K, V> extends MutableConfiguration<K, V> { } /** + * Gets near eviction policy. By default, returns {@code null} + * which means that evictions are disabled for near cache. + * * @return Near eviction policy. + * @see CacheConfiguration#getEvictionPolicy() + * @see CacheConfiguration#isEvictSynchronized() */ public EvictionPolicy<K, V> getNearEvictionPolicy() { return nearEvictPlc; } /** + * Sets near eviction policy. + * * @param nearEvictPlc Near eviction policy. * @return {@code this} for chaining. */ @@ -97,4 +111,4 @@ public class NearCacheConfiguration<K, V> extends MutableConfiguration<K, V> { @Override public String toString() { return S.toString(NearCacheConfiguration.class, this, super.toString()); } -} \ No newline at end of file +}