commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From simonetrip...@apache.org
Subject svn commit: r1129297 - /commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/substitution/MultiVariableExpander.java
Date Mon, 30 May 2011 19:07:14 GMT
Author: simonetripodi
Date: Mon May 30 19:07:14 2011
New Revision: 1129297

URL: http://svn.apache.org/viewvc?rev=1129297&view=rev
Log:
added missing javadoc comments

Modified:
    commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/substitution/MultiVariableExpander.java

Modified: commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/substitution/MultiVariableExpander.java
URL: http://svn.apache.org/viewvc/commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/substitution/MultiVariableExpander.java?rev=1129297&r1=1129296&r2=1129297&view=diff
==============================================================================
--- commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/substitution/MultiVariableExpander.java
(original)
+++ commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/substitution/MultiVariableExpander.java
Mon May 30 19:07:14 2011
@@ -39,6 +39,12 @@ public class MultiVariableExpander
 
     private final ArrayList<Map<String, Object>> sources = new ArrayList<Map<String,
Object>>( 2 );
 
+    /**
+     * Add a new variables source, identified by the input marker
+     *
+     * @param marker The input variables marker
+     * @param source The variables source
+     */
     public void addSource( String marker, Map<String, Object> source )
     {
         ++nEntries;
@@ -47,10 +53,7 @@ public class MultiVariableExpander
     }
 
     /**
-     * Expands any variable declarations using any of the known variable marker strings.
-     *
-     * @throws IllegalArgumentException if the input param references a variable which is
not known to the specified
-     * source.
+     * {@inheritDoc}
      */
     public String expand( String param )
     {
@@ -69,9 +72,11 @@ public class MultiVariableExpander
      * Returns the string after performing all substitutions.
      * <p>
      * If no substitutions were made, the input string object is returned (not a copy).
-     * 
-     * @throws IllegalArgumentException if the input param references a variable which is
not known to the specified
-     *             source.
+     *
+     * @param str 
+     * @param marker 
+     * @param source 
+     * @return 
      */
     public String expand( String str, String marker, Map<String, Object> source )
     {



Mime
View raw message