- TrackingMap.getWrappedMap() added

jdereg · jdereg · commit b758038c2ff4 · 2016-03-04T02:06:25.000-05:00
- TrackingMap.get() counts as accessed if the value associated to the key was null.
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@ To include in your project:
 <dependency>
   <groupId>com.cedarsoftware</groupId>
   <artifactId>java-util</artifactId>
-  <version>1.20.1</version>
+  <version>1.20.2</version>
 </dependency>
 ```
 Like **java-util** and find it useful? **Tip** bitcoin: 1MeozsfDpUALpnu3DntHWXxoPJXvSAXmQA
@@ -46,6 +46,9 @@ Including in java-util:
 * **UrlInvocationHandler** - Use to easily communicate with RESTful JSON servers, especially ones that implement a Java interface that you have access to.
 
 Version History
+* 1.20.2
+ * TrackingMap changed so that .get(key) that returns null, but key was inside Map, still counts as access.
+ * TrackingMap.getWrappedMap() added so that you can fetch the wrapped Map.
 * 1.20.1
  * TrackingMap changed so that .put() does not mark the key as accessed.
 * 1.20.0
diff --git a/pom.xml b/pom.xml
@@ -5,7 +5,7 @@
     <groupId>com.cedarsoftware</groupId>
     <artifactId>java-util</artifactId>
     <packaging>jar</packaging>
-    <version>1.20.1</version>
+    <version>1.20.2</version>
     <description>Java Utilities</description>
     <url>https://github.com/jdereg/java-util</url>
 
diff --git a/src/main/java/com/cedarsoftware/util/TrackingMap.java b/src/main/java/com/cedarsoftware/util/TrackingMap.java
@@ -39,8 +39,16 @@ public TrackingMap(Map<K, V> map) {
 
     public V get(Object key) {
         V value = internalMap.get(key);
-        if (value != null) {
-            readKeys.add((K)key);
+        if (value == null)
+        {
+            if (containsKey(key))
+            {
+                readKeys.add((K)key);
+            }
+        }
+        else
+        {
+            readKeys.add((K) key);
         }
         return value;
     }
@@ -121,4 +129,6 @@ public void informAdditionalUsage(TrackingMap<K, V> additional) {
     }
 
     public Set<K> keysUsed() { return readKeys; }
+
+    public Map getWrappedMap() { return internalMap; }
 }
diff --git a/src/test/java/com/cedarsoftware/util/TestTrackingMap.java b/src/test/java/com/cedarsoftware/util/TestTrackingMap.java
@@ -3,19 +3,24 @@
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.mockito.Mock;
-import org.powermock.api.mockito.PowerMockito;
-import org.powermock.core.classloader.annotations.PrepareForTest;
 import org.powermock.modules.junit4.PowerMockRunner;
 
-import java.util.*;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.LinkedHashMap;
+import java.util.Map;
+import java.util.Set;
 
 import static junit.framework.TestCase.assertFalse;
-import static org.junit.Assert.*;
-import static org.mockito.Matchers.any;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertTrue;
+import static org.junit.Assert.fail;
 import static org.mockito.Mockito.verify;
 
 @SuppressWarnings("ResultOfMethodCallIgnored")
-@PrepareForTest({TrackingMap.class, Map.class})
 @RunWith(PowerMockRunner.class)
 public class TestTrackingMap
 {
@@ -326,7 +331,7 @@ public void testConstructWithNull()
     }
 
     @Test
-    public void testPutCountsAsAccess()
+    public void testPuDoesNotCountAsAccess()
     {
         TrackingMap trackMap = new TrackingMap(new CaseInsensitiveMap());
         trackMap.put("k", "kite");
@@ -335,7 +340,53 @@ public void testPutCountsAsAccess()
         assert trackMap.keysUsed().size() == 0;
 
         trackMap.put("K", "kilo");
-        assert trackMap.keysUsed().size() == 1;
+        assert trackMap.keysUsed().size() == 0;
         assert trackMap.size() == 2;
     }
+
+    @Test
+    public void testContainsKeyNotCoundOnNonExistentKey()
+    {
+        TrackingMap trackMap = new TrackingMap(new CaseInsensitiveMap());
+        trackMap.put("y", "yankee");
+        trackMap.put("z", "zulu");
+
+        trackMap.containsKey("f");
+
+        assert trackMap.keysUsed().size() == 0;
+    }
+
+    @Test
+    public void testGetNotCoundOnNonExistentKey()
+    {
+        TrackingMap trackMap = new TrackingMap(new CaseInsensitiveMap());
+        trackMap.put("y", "yankee");
+        trackMap.put("z", "zulu");
+
+        trackMap.get("f");
+
+        assert trackMap.keysUsed().size() == 0;
+    }
+
+    @Test
+    public void testGetOfNullValueCountsAsAccess()
+    {
+        TrackingMap trackMap = new TrackingMap(new CaseInsensitiveMap());
+
+        trackMap.put("y", null);
+        trackMap.put("z", "zulu");
+
+        trackMap.get("y");
+
+        assert trackMap.keysUsed().size() == 1;
+    }
+
+    @Test
+    public void testFetchInternalMap()
+    {
+        TrackingMap trackMap = new TrackingMap(new CaseInsensitiveMap());
+        assert trackMap.getWrappedMap() instanceof CaseInsensitiveMap;
+        trackMap = new TrackingMap(new HashMap());
+        assert trackMap.getWrappedMap() instanceof HashMap;
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -39,8 +39,16 @@ public TrackingMap(Map<K, V> map) {`
`39`	`39`
`40`	`40`	`public V get(Object key) {`
`41`	`41`	`V value = internalMap.get(key);`
`42`		`- if (value != null) {`
`43`		`- readKeys.add((K)key);`
	`42`	`+ if (value == null)`
	`43`	`+ {`
	`44`	`+ if (containsKey(key))`
	`45`	`+ {`
	`46`	`+ readKeys.add((K)key);`
	`47`	`+ }`
	`48`	`+ }`
	`49`	`+ else`
	`50`	`+ {`
	`51`	`+ readKeys.add((K) key);`
`44`	`52`	`}`
`45`	`53`	`return value;`
`46`	`54`	`}`
`@@ -121,4 +129,6 @@ public void informAdditionalUsage(TrackingMap<K, V> additional) {`
`121`	`129`	`}`
`122`	`130`
`123`	`131`	`public Set<K> keysUsed() { return readKeys; }`
	`132`	`+`
	`133`	`+ public Map getWrappedMap() { return internalMap; }`
`124`	`134`	`}`