From 3b9df5ffc6ad1d2a182f0bb62852594d80409495 Mon Sep 17 00:00:00 2001
From: Grant Ingersoll <gsingers@apache.org>
Date: Thu, 22 May 2008 19:20:04 +0000
Subject: [PATCH] Added javadocs

git-svn-id: https://svn.apache.org/repos/asf/lucene/solr/trunk@659216 13f79535-47bb-0310-9956-ffa450edef68
---
 .../solr/handler/component/SearchComponent.java    | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/src/java/org/apache/solr/handler/component/SearchComponent.java b/src/java/org/apache/solr/handler/component/SearchComponent.java
index 6661bb2025a..c8661f8ac92 100644
--- a/src/java/org/apache/solr/handler/component/SearchComponent.java
+++ b/src/java/org/apache/solr/handler/component/SearchComponent.java
@@ -36,7 +36,21 @@ import org.apache.solr.util.plugin.NamedListInitializedPlugin;
  */
 public abstract class SearchComponent implements SolrInfoMBean, NamedListInitializedPlugin
 {
+  /**
+   * Prepare the response.  Guaranteed to be called before any SearchComponent {@link #process(org.apache.solr.handler.component.ResponseBuilder)} method.
+   * Called for every incoming request.
+   *
+   * The place to do initialization that is request dependent.
+   * @param rb The {@link org.apache.solr.handler.component.ResponseBuilder}
+   * @throws IOException
+   */
   public abstract void prepare(ResponseBuilder rb) throws IOException;
+
+  /**
+   * Process the request for this component 
+   * @param rb The {@link ResponseBuilder}
+   * @throws IOException
+   */
   public abstract void process(ResponseBuilder rb) throws IOException;
 
   /** Process for a distributed search.