applying patch tuscany_2552_phillipe_ramalho_09_30_2009.patch from TUSCANY-2552

git-svn-id: http://svn.us.apache.org/repos/asf/tuscany@830448 13f79535-47bb-0310-9956-ffa450edef68

1 files changed, 13 insertions, 0 deletions

diff --git a/branches/sca-java-1.x/modules/domain-search/src/main/java/org/apache/tuscany/sca/domain/search/DocumentMap.java b/branches/sca-java-1.x/modules/domain-search/src/main/java/org/apache/tuscany/sca/domain/search/DocumentMap.java
index d185bdf21d..47deb41a6f 100644
--- a/branches/sca-java-1.x/modules/domain-search/src/main/java/org/apache/tuscany/sca/domain/search/DocumentMap.java
+++ b/branches/sca-java-1.x/modules/domain-search/src/main/java/org/apache/tuscany/sca/domain/search/DocumentMap.java
@@ -23,6 +23,11 @@ import java.util.HashMap;
 import org.apache.tuscany.sca.domain.search.impl.Document;
 
 /**
+ * A map that holds a collection of {@link Document}s. Each {@link Document} key
+ * should ideally be something that is unique across the entire contribution
+ * documents. This class overrides {@link HashMap#get(Object)} method, so it
+ * adds an empty {@link Document} object if the specified key is not found in
+ * the map.
  * 
  * @version $Rev$ $Date$
  */
@@ -30,6 +35,14 @@ public class DocumentMap extends HashMap<Object, Document> {
 
     private static final long serialVersionUID = -2402910290314939928L;
 
+    /**
+     * Returns a {@link Document} object mapped from the specified key. If no
+     * {@link Document} object is found from the specified key, a empty
+     * {@link Document} object is created and added to the map.
+     * 
+     * @param key the {@link Document} key
+     * @return the {@link Document} object mapped from the key
+     */
     @Override
     public Document get(Object key) {
         Document doc = super.get(key);