svn commit: r585911 - /webservices/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/config/SynapseConfiguration.java

[ru...@apache.org]

Author: ruwan
Date: Thu Oct 18 02:57:11 2007
New Revision: 585911

URL: http://svn.apache.org/viewvc?rev=585911&view=rev
Log:
Adding comments to the newly added methods

Modified:
    webservices/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/config/SynapseConfiguration.java

Modified: webservices/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/config/SynapseConfiguration.java
URL: http://svn.apache.org/viewvc/webservices/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/config/SynapseConfiguration.java?rev=585911&r1=585910&r2=585911&view=diff
==============================================================================
--- webservices/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/config/SynapseConfiguration.java (original)
+++ webservices/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/config/SynapseConfiguration.java Thu Oct 18 02:57:11 2007
@@ -607,8 +607,7 @@
     /**
      * Get the Startup with the specified name
      * 
-     * @param id  
-     *          String name of the startup to be retrieved
+     * @param id - String name of the startup to be retrieved
      * @return Startup object with the specified name or null
      */
     public Startup getStartup(String id) {
@@ -618,21 +617,47 @@
     /**
      * Add a startup to the startups map in the configuration
      *
-     * @param startup
-     *              Startup object to be added 
+     * @param startup - Startup object to be added 
      */
     public void addStartup(Startup startup) {
         startups.put(startup.getName(), startup);
     }
 
+    /**
+     * Removes the startup specified by the name
+     * 
+     * @param name - name of the startup that needs to be removed
+     */
+    public void removeStartup(String name) {
+        startups.remove(name);
+    }
+
+    /**
+     * Gets the properties to configure the synapse enviorenment
+     * 
+     * @return set of properties as Properties
+     */
     public Properties getProperties() {
         return properties;
     }
 
+    /**
+     * Sets the properties to configure the synapse enviorenment
+     *
+     * @param properties - Properties which needs to be set
+     */
     public void setProperties(Properties properties) {
         this.properties = properties;
     }
 
+    /**
+     * Gets the String representation of the property value if there is a property for the
+     * given propKey or returns the default value passed
+     * 
+     * @param propKey - key for the property lookup
+     * @param def     - default value
+     * @return String representation of the property value with the given key or the def value
+     */
     public String getProperty(String propKey, String def) {
         String val = System.getProperty(propKey);
         if (val == null) {
@@ -648,6 +673,12 @@
         return def;
     }
 
+    /**
+     * Gets the propety value if the property specified by the propKey is there or null else
+     *
+     * @param propKey - key for the property lookup
+     * @return String representation of the property value if found or null else
+     */
     public String getProperty(String propKey) {
         String val = System.getProperty(propKey);
         if (val == null) {



---------------------------------------------------------------------
To unsubscribe, e-mail: synapse-dev-unsubscribe@ws.apache.org
For additional commands, e-mail: synapse-dev-help@ws.apache.org