[geode] branch develop updated: GEODE-5113: fix javadocs on getMaximum (#1843)

[ds...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

dschneider pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/geode.git


The following commit(s) were added to refs/heads/develop by this push:
     new 1d474c0  GEODE-5113: fix javadocs on getMaximum (#1843)
1d474c0 is described below

commit 1d474c0457586c1b7b271f3c19cdc9d4218474b8
Author: Darrel Schneider <ds...@pivotal.io>
AuthorDate: Tue Apr 24 12:06:27 2018 -0700

    GEODE-5113: fix javadocs on getMaximum (#1843)
---
 .../main/java/org/apache/geode/cache/EvictionAttributes.java   | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/geode-core/src/main/java/org/apache/geode/cache/EvictionAttributes.java b/geode-core/src/main/java/org/apache/geode/cache/EvictionAttributes.java
index 155d9c2..26b84e5 100644
--- a/geode-core/src/main/java/org/apache/geode/cache/EvictionAttributes.java
+++ b/geode-core/src/main/java/org/apache/geode/cache/EvictionAttributes.java
@@ -423,7 +423,15 @@ public abstract class EvictionAttributes implements DataSerializable {
 
   /**
    * The unit of this value is determined by the definition of the {@link EvictionAlgorithm} set by
-   * one of the creation methods e.g. {@link EvictionAttributes#createLRUEntryAttributes()}
+   * one of the creation methods e.g. {@link EvictionAttributes#createLRUEntryAttributes()}.
+   * <ul>
+   * <li>If the algorithm is LRU_ENTRY then the unit is entries.
+   * <li>If the algorithm is LRU_MEMORY then the unit is megabytes.
+   * <li>If the algorithm is LRU_HEAP then the unit is undefined and this method always returns
+   * zero.
+   * Note, in geode 1.4 and earlier, this method would throw UnsupportedOperationException for
+   * LRU_HEAP.
+   * </ul>
    *
    * @return maximum value used by the {@link EvictionAlgorithm} which determines when the
    *         {@link EvictionAction} is performed.

-- 
To stop receiving notification emails like this one, please contact
dschneider@apache.org.