BroadleafCommerce#1309 - Update javadocs

Author: jefffischer

core/broadleaf-framework/src/main/java/org/broadleafcommerce/core/search/service/solr/IndexStatusInfo.java

@@ -23,14 +23,28 @@
 import java.util.Map;
 
 /**
+ * General information about the current status of a (embedded) Solr instance's index
+ *
  * @author Jeff Fischer
  */
 public interface IndexStatusInfo {
+
+    /**
+     * The most recent index date
+     *
+     * @return
+     */
     Date getLastIndexDate();
 
     void setLastIndexDate(Date lastIndexDate);
 
+    /**
+     * Arbitrary information about the index.
+     *
+     * @return
+     */
     Map<String, String> getAdditionalInfo();
 
     void setAdditionalInfo(Map<String, String> additionalInfo);
+
 }

core/broadleaf-framework/src/main/java/org/broadleafcommerce/core/search/service/solr/SolrIndexStatusProvider.java

@@ -20,10 +20,14 @@
 package org.broadleafcommerce.core.search.service.solr;
 
 /**
+ * Responsible for reading and writing the index status to some persistent store (e.g. the file system).
+ *
  * @author Jeff Fischer
  */
 public interface SolrIndexStatusProvider {
+
     void handleUpdateIndexStatus(IndexStatusInfo status);
 
     IndexStatusInfo readIndexStatus(IndexStatusInfo status);
+
 }

core/broadleaf-framework/src/main/java/org/broadleafcommerce/core/search/service/solr/SolrIndexStatusService.java

@@ -20,6 +20,10 @@
 package org.broadleafcommerce.core.search.service.solr;
 
 /**
+ * Responsible for reading and writing the status using one or more {@link org.broadleafcommerce.core.search.service.solr.SolrIndexStatusProvider}
+ * instances. {@link #getSeedStatusInstance()} can be used to provide a custom {@link org.broadleafcommerce.core.search.service.solr.IndexStatusInfo}
+ * implementation.
+ *
  * @author Jeff Fischer
  */
 public interface SolrIndexStatusService {
@@ -28,5 +32,11 @@ public interface SolrIndexStatusService {
 
     IndexStatusInfo getIndexStatus();
 
+    /**
+     * Provide a custom IndexStatusInfo instance to be used by the system.
+     *
+     * @return
+     */
     IndexStatusInfo getSeedStatusInstance();
+
 }