Author: ssmiweve
Date: 2008-12-15 16:47:12 +0100 (Mon, 15 Dec 2008)
New Revision: 7099

Modified:
   branches/2.18/result-spi/src/main/java/no/sesat/search/result/ResultList.java
Log:
also override addObjectField(..) to give a more accurate return type

Modified: 
branches/2.18/result-spi/src/main/java/no/sesat/search/result/ResultList.java
===================================================================
--- 
branches/2.18/result-spi/src/main/java/no/sesat/search/result/ResultList.java   
    2008-12-15 15:46:02 UTC (rev 7098)
+++ 
branches/2.18/result-spi/src/main/java/no/sesat/search/result/ResultList.java   
    2008-12-15 15:47:12 UTC (rev 7099)
@@ -22,25 +22,26 @@
 
 package no.sesat.search.result;
 
+import java.io.Serializable;
 import java.util.Comparator;
 import java.util.Collection;
 import java.util.List;
 
-/**
+/** A list of ResultItems.
+ * The list itself is a "result" that contain properties (suggestions, 
relevant queries, etc).
  *
- * @param T
- *
+ * @param <T> the result item type the list contains.
  * @version $Id$
  */
 public interface ResultList<T extends ResultItem> extends ResultItem{
 
-    /**
+    /** Get the hitcount. May not match getResults().size().
      *
      * @return
      */
     int getHitCount();
 
-    /**
+    /** Set the hitcount.
      *
      * @param hitCount
      */
@@ -135,10 +136,18 @@
     List<WeightedSuggestion> getRelevantQueries();
 
     /** Opposed to the superinterface, ResultLists can mutate and this method 
will return itself.
-     *
-     * @param name
-     * @param value
+     * {...@inheritdoc}
+     * @param name {...@inheritdoc}
+     * @param value {...@inheritdoc}
      */
+    @Override
     ResultList<T> addField(String name, String value);
 
+    /** Opposed to the superinterface, ResultLists can mutate and this method 
will return itself.
+     * {...@inheritdoc}
+     * @param name {...@inheritdoc}
+     * @param value {...@inheritdoc}
+     */
+    @Override
+    ResultList<T> addObjectField(String name, Serializable value);
 }

_______________________________________________
Kernel-commits mailing list
[email protected]
http://sesat.no/mailman/listinfo/kernel-commits

Reply via email to