svn commit: r703376 - /forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/java/org/apache/forrest/dispatcher/impl/helper/XMLProperties.java

[thorsten]

Author: thorsten
Date: Fri Oct 10 03:06:55 2008
New Revision: 703376

URL: http://svn.apache.org/viewvc?rev=703376&view=rev
Log:
Adding more javadoc comments

Modified:
    
forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/java/org/apache/forrest/dispatcher/impl/helper/XMLProperties.java

Modified: 
forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/java/org/apache/forrest/dispatcher/impl/helper/XMLProperties.java
URL: 
http://svn.apache.org/viewvc/forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/java/org/apache/forrest/dispatcher/impl/helper/XMLProperties.java?rev=703376&r1=703375&r2=703376&view=diff
==============================================================================
--- 
forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/java/org/apache/forrest/dispatcher/impl/helper/XMLProperties.java
 (original)
+++ 
forrest/branches/dispatcher_rewrite/plugins/org.apache.forrest.plugin.internal.dispatcher/src/java/org/apache/forrest/dispatcher/impl/helper/XMLProperties.java
 Fri Oct 10 03:06:55 2008
@@ -24,11 +24,35 @@
 import javax.xml.stream.XMLStreamException;
 import javax.xml.stream.XMLStreamReader;
 
+/**
+ * This class a helper class to extract the properties that
+ * are stored in a forrest.properties.xml file.
+ * 
+ * @version 1.0
+ *
+ */
 public class XMLProperties {
   
+ 
   private XMLProperties (){
   }
 
+  /**
+   * Will extract the properties of the in coming forrest.properties.xml.
+   * <p>
+   * The extracted key, value pairs will be added to the map that has been
+   * passed to the method.
+   * @param stream forrest.properties.xml like properties stream.
+   * like e.g. 
+   * <code><pre>
+   * &lt;properties input-module="properties">
+   *  &lt;property name="dispatcher.caching" value="on"/>
+   *  &lt;-- ... -->
+   * &lt;/properties>
+   * </pre><code>
+   * @param map the map where we want to store the extracted variables.
+   * @throws XMLStreamException
+   */
   public static void parseProperties(InputStream stream, Map<String, Object> 
map) throws XMLStreamException{
     XMLStreamReader reader  = 
XMLInputFactory.newInstance().createXMLStreamReader(stream);
     boolean loop = true;