IGNITE-5075 CacheConfiguration.groupName: update javadoc
Project: http://git-wip-us.apache.org/repos/asf/ignite/repo Commit: http://git-wip-us.apache.org/repos/asf/ignite/commit/0a6b44ce Tree: http://git-wip-us.apache.org/repos/asf/ignite/tree/0a6b44ce Diff: http://git-wip-us.apache.org/repos/asf/ignite/diff/0a6b44ce Branch: refs/heads/ignite-5272 Commit: 0a6b44cee31084f35591f3a4d28c69d68ebeb857 Parents: d2efe78 Author: Pavel Tupitsyn <[email protected]> Authored: Wed Jun 7 19:46:54 2017 +0300 Committer: Pavel Tupitsyn <[email protected]> Committed: Wed Jun 7 19:46:54 2017 +0300 ---------------------------------------------------------------------- .../configuration/CacheConfiguration.java | 24 ++++++++++++++++++++ 1 file changed, 24 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/ignite/blob/0a6b44ce/modules/core/src/main/java/org/apache/ignite/configuration/CacheConfiguration.java ---------------------------------------------------------------------- diff --git a/modules/core/src/main/java/org/apache/ignite/configuration/CacheConfiguration.java b/modules/core/src/main/java/org/apache/ignite/configuration/CacheConfiguration.java index 67b7590..6e0836e 100644 --- a/modules/core/src/main/java/org/apache/ignite/configuration/CacheConfiguration.java +++ b/modules/core/src/main/java/org/apache/ignite/configuration/CacheConfiguration.java @@ -459,6 +459,18 @@ public class CacheConfiguration<K, V> extends MutableConfiguration<K, V> { } /** + * Gets the cache group name. + * + * Caches with the same group name share single underlying 'physical' cache (partition set), + * but are logically isolated. + * + * Since underlying cache is shared, the following configuration properties should be the same within group: + * {@link #setAffinity(AffinityFunction)}, {@link #setNodeFilter(IgnitePredicate)}, {@link #cacheMode}, + * {@link #setTopologyValidator(TopologyValidator)}, {@link #setPartitionLossPolicy(PartitionLossPolicy)}, + * {@link #setMemoryPolicyName(String)}. + * + * Grouping caches reduces overall overhead, since internal data structures are shared. + * * @return Cache group name. */ public String getGroupName() { @@ -466,6 +478,18 @@ public class CacheConfiguration<K, V> extends MutableConfiguration<K, V> { } /** + * Sets the cache group name. + * + * Caches with the same group name share single underlying 'physical' cache (partition set), + * but are logically isolated. + * + * Since underlying cache is shared, the following configuration properties should be the same within group: + * {@link #setAffinity(AffinityFunction)}, {@link #setNodeFilter(IgnitePredicate)}, {@link #cacheMode}, + * {@link #setTopologyValidator(TopologyValidator)}, {@link #setPartitionLossPolicy(PartitionLossPolicy)}, + * {@link #setMemoryPolicyName(String)}. + * + * Grouping caches reduces overall overhead, since internal data structures are shared. + * * @param grpName Cache group name. * @return {@code this} for chaining. */
