Merge pull request #16377 from vespa-engine/bratseth/caching-warning

Warn not to cache hits

1 files changed, 4 insertions, 2 deletions

diff --git a/container-search/src/main/java/com/yahoo/search/result/Hit.java b/container-search/src/main/java/com/yahoo/search/result/Hit.java
index c4e287bddb1..d224ec2c7ab 100644
--- a/container-search/src/main/java/com/yahoo/search/result/Hit.java
+++ b/container-search/src/main/java/com/yahoo/search/result/Hit.java
@@ -35,6 +35,8 @@ import java.util.function.BiConsumer;
  * done of a lightweight version of the hits, which is cheaper if a significant
  * number of hits are filtered out.</p>
  *
+ * <p>Do not cache this as it holds references to objects that should be garbage collected.</p>
+ *
  * @author bratseth
  */
 public class Hit extends ListenableFreezableClass implements Data, Comparable<Hit>, Cloneable {
@@ -45,8 +47,8 @@ public class Hit extends ListenableFreezableClass implements Data, Comparable<Hi
     private static final String DOCUMENT_ID = "documentid";
 
     /** A collection of string keyed object properties. */
-    private Map<String,Object> fields = null;
-    private Map<String,Object> unmodifiableFieldMap = null;
+    private Map<String, Object> fields = null;
+    private Map<String, Object> unmodifiableFieldMap = null;
 
     /** Meta data describing how a given searcher should treat this hit. */
     // TODO: The case for this is to allow multiple levels of federation searcher routing.