svn commit: r709585 - in /ofbiz/trunk/framework/base/src/org/ofbiz/base: config/ util/ util/collections/ util/string/ util/template/

[doogie-3]

Author: doogie
Date: Fri Oct 31 15:15:48 2008
New Revision: 709585

URL: http://svn.apache.org/viewvc?rev=709585&view=rev
Log:
Javadoc updates; no warnings!

Modified:
    ofbiz/trunk/framework/base/src/org/ofbiz/base/config/ResourceLoader.java
    ofbiz/trunk/framework/base/src/org/ofbiz/base/config/SecurityConfigUtil.java
    ofbiz/trunk/framework/base/src/org/ofbiz/base/util/ObjectType.java
    ofbiz/trunk/framework/base/src/org/ofbiz/base/util/StringUtil.java
    ofbiz/trunk/framework/base/src/org/ofbiz/base/util/TimeDuration.java
    ofbiz/trunk/framework/base/src/org/ofbiz/base/util/UtilDateTime.java
    ofbiz/trunk/framework/base/src/org/ofbiz/base/util/UtilHttp.java
    ofbiz/trunk/framework/base/src/org/ofbiz/base/util/UtilMisc.java
    ofbiz/trunk/framework/base/src/org/ofbiz/base/util/UtilObject.java
    ofbiz/trunk/framework/base/src/org/ofbiz/base/util/UtilParse.java
    ofbiz/trunk/framework/base/src/org/ofbiz/base/util/collections/FlexibleMapAccessor.java
    ofbiz/trunk/framework/base/src/org/ofbiz/base/util/collections/FlexibleServletAccessor.java
    ofbiz/trunk/framework/base/src/org/ofbiz/base/util/string/FlexibleStringExpander.java
    ofbiz/trunk/framework/base/src/org/ofbiz/base/util/template/FreeMarkerWorker.java

Modified: ofbiz/trunk/framework/base/src/org/ofbiz/base/config/ResourceLoader.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/base/src/org/ofbiz/base/config/ResourceLoader.java?rev=709585&r1=709584&r2=709585&view=diff
==============================================================================
--- ofbiz/trunk/framework/base/src/org/ofbiz/base/config/ResourceLoader.java (original)
+++ ofbiz/trunk/framework/base/src/org/ofbiz/base/config/ResourceLoader.java Fri Oct 31 15:15:48 2008
@@ -29,8 +29,7 @@
 import org.w3c.dom.Element;
 
 /**
- * Loads resources using dynamically specified resource loader classes
- *
+ * Loads resources using dynamically specified resource loader classes.
  */
 public abstract class ResourceLoader {
     
@@ -172,9 +171,10 @@
         this.envName = envName;
     }
 
-    /** Just a utility method to be used in loadResource by the implementing class * @param location
+    /**
+     * Just a utility method to be used in loadResource by the implementing class.
      * @param location
-     * @return
+     * @return the built-up full location
      */
     public String fullLocation(String location) {
         StringBuilder buf = new StringBuilder();

Modified: ofbiz/trunk/framework/base/src/org/ofbiz/base/config/SecurityConfigUtil.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/base/src/org/ofbiz/base/config/SecurityConfigUtil.java?rev=709585&r1=709584&r2=709585&view=diff
==============================================================================
--- ofbiz/trunk/framework/base/src/org/ofbiz/base/config/SecurityConfigUtil.java (original)
+++ ofbiz/trunk/framework/base/src/org/ofbiz/base/config/SecurityConfigUtil.java Fri Oct 31 15:15:48 2008
@@ -43,9 +43,9 @@
     protected static Map<String, SecurityInfo> securityInfos = FastMap.newInstance();
 
     /**
-     * Returns the XmlRootElement for the security config
+     * Returns the XmlRootElement for the security config.
      *
-     * @return
+     * @return the root element for the security config
      * @throws GenericConfigException
      */
     public static Element getXmlRootElement() throws GenericConfigException {
@@ -53,9 +53,9 @@
     }
 
     /**
-     * Returns the XmlDocument for the security config
+     * Returns the XmlDocument for the security config.
      *
-     * @return
+     * @return the Document descripting the security config
      * @throws GenericConfigException
      */
     public static Document getXmlDocument() throws GenericConfigException {
@@ -71,7 +71,7 @@
     }
 
     /**
-     * Initializes the security configuration
+     * Initializes the security configuration.
      *
      * @param rootElement
      * @throws GenericConfigException
@@ -87,10 +87,10 @@
     }
 
     /**
-     * Returns the security config for a given name
+     * Returns the security config for a given name.
      *
      * @param name
-     * @return
+     * @return the found SecurityInfo
      */
     public static SecurityConfigUtil.SecurityInfo getSecurityInfo(String name) {
         return securityInfos.get(name);
@@ -104,7 +104,7 @@
         public final String className;
 
         /**
-         * Creates a SecurityInfo for a given element
+         * Creates a SecurityInfo for a given element.
          *
          * @param element
          */

Modified: ofbiz/trunk/framework/base/src/org/ofbiz/base/util/ObjectType.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/base/src/org/ofbiz/base/util/ObjectType.java?rev=709585&r1=709584&r2=709585&view=diff
==============================================================================
--- ofbiz/trunk/framework/base/src/org/ofbiz/base/util/ObjectType.java (original)
+++ ofbiz/trunk/framework/base/src/org/ofbiz/base/util/ObjectType.java Fri Oct 31 15:15:48 2008
@@ -48,7 +48,7 @@
     public static final String SQL_PACKAGE = "java.sql.";   // We will test both the raw value and this + raw value
 
     /**
-     * Loads a class with the current thread's context classloader
+     * Loads a class with the current thread's context classloader.
      * @param className The name of the class to load
      * @return The requested class
      * @throws ClassNotFoundException
@@ -63,9 +63,9 @@
     }
 
     /**
-     * Loads a class with the current thread's context classloader
+     * Loads a class with the current thread's context classloader.
      * @param className The name of the class to load
-     * @param loader The ClassLoader to su
+     * @param loader The ClassLoader to use
      * @return The requested class
      * @throws ClassNotFoundException
      */
@@ -116,7 +116,8 @@
     }
 
     /**
-     * Returns an instance of the specified class
+     * Returns an instance of the specified class.  This uses the default
+     * no-arg constructor to create the instance.
      * @param className Name of the class to instantiate
      * @return An instance of the named class
      * @throws ClassNotFoundException
@@ -133,10 +134,10 @@
     }
 
     /**
-     * Tests if a class properly implements the specified interface
+     * Tests if a class properly implements the specified interface.
      * @param objectClass Class to test
      * @param interfaceName Name of the interface to test against
-     * @return boolean indicating whether interfaceName is an interface of the obj
+     * @return true if interfaceName is an interface of objectClass
      * @throws ClassNotFoundException
      */
     public static boolean interfaceOf(Class<?> objectClass, String interfaceName) throws ClassNotFoundException {
@@ -146,10 +147,10 @@
     }
 
     /**
-     * Tests if a class properly implements the specified interface
+     * Tests if a class properly implements the specified interface.
      * @param objectClass Class to test
      * @param interfaceObject to test against
-     * @return boolean indicating whether interfaceObject is an interface of the obj
+     * @return true if interfaceObject is an interface of the objectClass
      */
     public static boolean interfaceOf(Class<?> objectClass, Object interfaceObject) {
         Class<?> interfaceClass = interfaceObject.getClass();
@@ -158,10 +159,10 @@
     }
 
     /**
-     * Returns an instance of the specified class using the constructor matching the specified parameters
+     * Returns an instance of the specified class using the constructor matching the specified parameters.
      * @param className Name of the class to instantiate
      * @param parameters Parameters passed to the constructor
-     * @return An instance of the named class
+     * @return An instance of the className
      * @throws ClassNotFoundException
      * @throws InstantiationException
      * @throws IllegalAccessException
@@ -181,10 +182,10 @@
     }
 
     /**
-     * Tests if an object properly implements the specified interface
+     * Tests if an object properly implements the specified interface.
      * @param obj Object to test
      * @param interfaceName Name of the interface to test against
-     * @return boolean indicating whether interfaceName is an interface of the obj
+     * @return true if interfaceName is an interface of obj
      * @throws ClassNotFoundException
      */
     public static boolean interfaceOf(Object obj, String interfaceName) throws ClassNotFoundException {
@@ -194,10 +195,10 @@
     }
 
     /**
-     * Tests if an object properly implements the specified interface
+     * Tests if an object properly implements the specified interface.
      * @param obj Object to test
      * @param interfaceObject to test against
-     * @return boolean indicating whether interfaceObject is an interface of the obj
+     * @return true if interfaceObject is an interface of obj
      */
     public static boolean interfaceOf(Object obj, Object interfaceObject) {
         Class<?> interfaceClass = interfaceObject.getClass();
@@ -206,10 +207,10 @@
     }
 
     /**
-     * Tests if an object properly implements the specified interface
+     * Tests if an object properly implements the specified interface.
      * @param obj Object to test
      * @param interfaceClass Class to test against
-     * @return boolean indicating whether interfaceClass is an interface of the obj
+     * @return true if interfaceClass is an interface of obj
      */
     public static boolean interfaceOf(Object obj, Class<?> interfaceClass) {
         Class<?> objectClass = obj.getClass();
@@ -218,10 +219,10 @@
     }
 
     /**
-     * Tests if a class properly implements the specified interface
+     * Tests if a class properly implements the specified interface.
      * @param objectClass Class to test
      * @param interfaceClass Class to test against
-     * @return boolean indicating whether interfaceClass is an interface of the obj
+     * @return true if interfaceClass is an interface of objectClass
      */
     public static boolean interfaceOf(Class<?> objectClass, Class<?> interfaceClass) {
         while (objectClass != null) {
@@ -236,10 +237,10 @@
     }
 
     /**
-     * Tests if a class is a class of or a sub-class of the parent
+     * Tests if a class is a class of or a sub-class of the parent.
      * @param objectClass Class to test
      * @param parentName Name of the parent class to test against
-     * @return
+     * @return true if objectClass is a class of or a sub-class of the parent
      * @throws ClassNotFoundException
      */
     public static boolean isOrSubOf(Class<?> objectClass, String parentName) throws ClassNotFoundException {
@@ -249,10 +250,10 @@
     }
 
     /**
-     * Tests if a class is a class of or a sub-class of the parent
+     * Tests if a class is a class of or a sub-class of the parent.
      * @param objectClass Class to test
      * @param parentObject Object to test against
-     * @return
+     * @return true if objectClass is a class of or a sub-class of the parent
      */
     public static boolean isOrSubOf(Class<?> objectClass, Object parentObject) {
         Class<?> parentClass = parentObject.getClass();
@@ -261,10 +262,10 @@
     }
 
     /**
-     * Tests if an object is an instance of or a sub-class of the parent
+     * Tests if an object is an instance of or a sub-class of the parent.
      * @param obj Object to test
      * @param parentName Name of the parent class to test against
-     * @return
+     * @return true if obj is an instance of or a sub-class of the parent
      * @throws ClassNotFoundException
      */
     public static boolean isOrSubOf(Object obj, String parentName) throws ClassNotFoundException {
@@ -274,10 +275,10 @@
     }
 
     /**
-     * Tests if an object is an instance of or a sub-class of the parent
+     * Tests if an object is an instance of or a sub-class of the parent.
      * @param obj Object to test
      * @param parentObject Object to test against
-     * @return
+     * @return true if obj is an instance of or a sub-class of the parent
      */
     public static boolean isOrSubOf(Object obj, Object parentObject) {
         Class<?> parentClass = parentObject.getClass();
@@ -286,10 +287,10 @@
     }
 
     /**
-     * Tests if an object is an instance of or a sub-class of the parent
+     * Tests if an object is an instance of or a sub-class of the parent.
      * @param obj Object to test
      * @param parentClass Class to test against
-     * @return
+     * @return true if obj is an instance of or a sub-class of the parent
      */
     public static boolean isOrSubOf(Object obj, Class<?> parentClass) {
         Class<?> objectClass = obj.getClass();
@@ -298,10 +299,10 @@
     }
 
     /**
-     * Tests if a class is a class of or a sub-class of the parent
+     * Tests if a class is a class of or a sub-class of the parent.
      * @param objectClass Class to test
      * @param parentClass Class to test against
-     * @return
+     * @return true if objectClass is a class of or a sub-class of the parent
      */
     public static boolean isOrSubOf(Class<?> objectClass, Class<?> parentClass) {
         //Debug.logInfo("Checking isOrSubOf for [" + objectClass.getName() + "] and [" + objectClass.getName() + "]", module);
@@ -313,10 +314,10 @@
     }
 
     /**
-     * Tests if a class is a class of a sub-class of or properly implements an interface
+     * Tests if a class is a class of a sub-class of or properly implements an interface.
      * @param objectClass Class to test
      * @param typeObject Object to test against
-     * @return
+     * @return true if objectClass is a class of a sub-class of, or properly implements an interface
      */
     public static boolean instanceOf(Class<?> objectClass, Object typeObject) {
         Class<?> typeClass = typeObject.getClass();
@@ -325,20 +326,20 @@
     }
 
     /**
-     * Tests if a class is a class of a sub-class of or properly implements an interface
+     * Tests if a class is a class of a sub-class of or properly implements an interface.
      * @param objectClass Class to test
      * @param typeName name to test against
-     * @return
+     * @return true if objectClass is a class or a sub-class of, or properly implements an interface
      */
     public static boolean instanceOf(Class<?> objectClass, String typeName) {
         return instanceOf(objectClass, typeName, null);
     }
 
     /**
-     * Tests if an object is an instance of a sub-class of or properly implements an interface
+     * Tests if an object is an instance of a sub-class of or properly implements an interface.
      * @param obj Object to test
      * @param typeObject Object to test against
-     * @return
+     * @return true if obj is an instance of a sub-class of, or properly implements an interface
      */
     public static boolean instanceOf(Object obj, Object typeObject) {
         Class<?> typeClass = typeObject.getClass();
@@ -347,21 +348,21 @@
     }
 
     /**
-     * Tests if an object is an instance of a sub-class of or properly implements an interface
+     * Tests if an object is an instance of a sub-class of or properly implements an interface.
      * @param obj Object to test
      * @param typeName name to test against
-     * @return
+     * @return true if obj is an instance of a sub-class of, or properly implements an interface
      */
     public static boolean instanceOf(Object obj, String typeName) {
         return instanceOf(obj, typeName, null);
     }
 
     /**
-     * Tests if a class is a class of a sub-class of or properly implements an interface
+     * Tests if a class is a class of a sub-class of or properly implements an interface.
      * @param objectClass Class to test
      * @param typeName Object to test against
      * @param loader
-     * @return
+     * @return true if objectClass is a class of a sub-class of, or properly implements an interface
      */
     public static boolean instanceOf(Class<?> objectClass, String typeName, ClassLoader loader) {
         Class<?> infoClass = loadInfoClass(typeName, loader);
@@ -373,11 +374,11 @@
     }
 
     /**
-     * Tests if an object is an instance of a sub-class of or properly implements an interface
+     * Tests if an object is an instance of a sub-class of or properly implements an interface.
      * @param obj Object to test
      * @param typeName Object to test against
      * @param loader
-     * @return
+     * @return true if obj is an instance of a sub-class of, or properly implements an interface
      */
     public static boolean instanceOf(Object obj, String typeName, ClassLoader loader) {
         Class<?> infoClass = loadInfoClass(typeName, loader);
@@ -418,10 +419,10 @@
     }
 
     /**
-     * Tests if an object is an instance of a sub-class of or properly implements an interface
+     * Tests if an object is an instance of a sub-class of or properly implements an interface.
      * @param obj Object to test
      * @param typeClass Class to test against
-     * @return
+     * @return true if obj is an instance of a sub-class of typeClass
      */
     public static boolean instanceOf(Object obj, Class<?> typeClass) {
         if (obj == null) return true;
@@ -430,10 +431,10 @@
     }
 
     /**
-     * Tests if a class is a class of a sub-class of or properly implements an interface
+     * Tests if a class is a class of a sub-class of or properly implements an interface.
      * @param objectClass Class to test
      * @param typeClass Class to test against
-     * @return
+     * @return true if objectClass is a class or sub-class of, or implements typeClass
      */
     public static boolean instanceOf(Class<?> objectClass, Class<?> typeClass) {
         if (typeClass.isInterface()) {
@@ -448,7 +449,7 @@
     }
 
     /**
-     * Converts the passed object to the named simple type; supported types
+     * Converts the passed object to the named simple type.  Supported types
      * include: String, Boolean, Double, Float, Long, Integer, Date (java.sql.Date),
      * Time, Timestamp, TimeZone;
      * @param obj Object to convert
@@ -457,7 +458,7 @@
      * @param timeZone Optional (can be null) TimeZone for converting dates and times
      * @param locale Optional (can be null) Locale for formatting and parsing Double, Float, Long, Integer
      * @param noTypeFail Fail (Exception) when no type conversion is available, false will return the primary object
-     * @return
+     * @return the converted value
      * @throws GeneralException
      */
     public static Object simpleTypeConvert(Object obj, String type, String format, TimeZone timeZone, Locale locale, boolean noTypeFail) throws GeneralException {

Modified: ofbiz/trunk/framework/base/src/org/ofbiz/base/util/StringUtil.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/base/src/org/ofbiz/base/util/StringUtil.java?rev=709585&r1=709584&r2=709585&view=diff
==============================================================================
--- ofbiz/trunk/framework/base/src/org/ofbiz/base/util/StringUtil.java (original)
+++ ofbiz/trunk/framework/base/src/org/ofbiz/base/util/StringUtil.java Fri Oct 31 15:15:48 2008
@@ -402,7 +402,7 @@
     /**
      * Add the number to the string, keeping (padding to min of original length)
      *
-     * @return
+     * @return the new value
      */
     public static String addToNumberString(String numberString, long addAmount) {
     if (numberString == null) return null;
@@ -459,8 +459,8 @@
     /**
      * Remove/collapse multiple newline characters
      *
-     * @param String string to collapse newlines in
-     * @return String
+     * @param str string to collapse newlines in
+     * @return the converted string
      */
     public static String collapseNewlines(String str) {
         return collapseCharacter(str, '\n');
@@ -469,8 +469,8 @@
     /**
      * Remove/collapse multiple spaces
      *
-     * @param String string to collapse spaces in
-     * @return String
+     * @param str string to collapse spaces in
+     * @return the converted string
      */
     public static String collapseSpaces(String str) {
         return collapseCharacter(str, ' ');
@@ -479,9 +479,9 @@
     /**
      * Remove/collapse multiple characters
      *
-     * @param String string to collapse characters in
-     * @param char character to collapse
-     * @return String
+     * @param str string to collapse characters in
+     * @param c character to collapse
+     * @return the converted string
      */
     public static String collapseCharacter(String str, char c) {
         StringBuffer sb = new StringBuffer();

Modified: ofbiz/trunk/framework/base/src/org/ofbiz/base/util/TimeDuration.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/base/src/org/ofbiz/base/util/TimeDuration.java?rev=709585&r1=709584&r2=709585&view=diff
==============================================================================
--- ofbiz/trunk/framework/base/src/org/ofbiz/base/util/TimeDuration.java (original)
+++ ofbiz/trunk/framework/base/src/org/ofbiz/base/util/TimeDuration.java Fri Oct 31 15:15:48 2008
@@ -267,7 +267,7 @@
      * <code>fromLong</code> method.
      *
      * @param duration
-     * @return
+     * @return the number number of milliseconds in the duration
      */
     public static long toLong(TimeDuration duration) {
         return

Modified: ofbiz/trunk/framework/base/src/org/ofbiz/base/util/UtilDateTime.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/base/src/org/ofbiz/base/util/UtilDateTime.java?rev=709585&r1=709584&r2=709585&view=diff
==============================================================================
--- ofbiz/trunk/framework/base/src/org/ofbiz/base/util/UtilDateTime.java (original)
+++ ofbiz/trunk/framework/base/src/org/ofbiz/base/util/UtilDateTime.java Fri Oct 31 15:15:48 2008
@@ -734,7 +734,7 @@
     /**
      * returns a day number in a week for a Timestamp input
      *
-     * @param input Timestamp date
+     * @param stamp Timestamp date
      * @return A int containing the day number (sunday = 1, saturday = 7)
      */
     public static int dayNumber(Timestamp stamp) {

Modified: ofbiz/trunk/framework/base/src/org/ofbiz/base/util/UtilHttp.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/base/src/org/ofbiz/base/util/UtilHttp.java?rev=709585&r1=709584&r2=709585&view=diff
==============================================================================
--- ofbiz/trunk/framework/base/src/org/ofbiz/base/util/UtilHttp.java (original)
+++ ofbiz/trunk/framework/base/src/org/ofbiz/base/util/UtilHttp.java Fri Oct 31 15:15:48 2008
@@ -1024,7 +1024,7 @@
      *
      * @param prefix
      * @param suffix
-     * @return
+     * @return the composite parameter
      */
     public static String makeCompositeParam(String prefix, String suffix) {
         return prefix + COMPOSITE_DELIMITER + suffix;    
@@ -1114,7 +1114,7 @@
      * checks, if the current request comes from a searchbot
      *
      * @param request
-     * @return
+     * @return whether the request is from a web searchbot
      */
     public static boolean checkURLforSpiders(HttpServletRequest request){
         boolean result = false;
@@ -1150,7 +1150,7 @@
 
     /** Returns true if the user has JavaScript enabled.
      * @param request
-     * @return
+     * @return whether javascript is enabled
      */
     public static boolean isJavaScriptEnabled(HttpServletRequest request) {
         HttpSession session = request.getSession();

Modified: ofbiz/trunk/framework/base/src/org/ofbiz/base/util/UtilMisc.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/base/src/org/ofbiz/base/util/UtilMisc.java?rev=709585&r1=709584&r2=709585&view=diff
==============================================================================
--- ofbiz/trunk/framework/base/src/org/ofbiz/base/util/UtilMisc.java (original)
+++ ofbiz/trunk/framework/base/src/org/ofbiz/base/util/UtilMisc.java Fri Oct 31 15:15:48 2008
@@ -523,7 +523,7 @@
     /**
      * Returns a double from value, where value could either be a Double or a String
      * @param value
-     * @return
+     * @return the converted double
      */
     public static double toDouble(Object value) {
         if (value != null) {

Modified: ofbiz/trunk/framework/base/src/org/ofbiz/base/util/UtilObject.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/base/src/org/ofbiz/base/util/UtilObject.java?rev=709585&r1=709584&r2=709585&view=diff
==============================================================================
--- ofbiz/trunk/framework/base/src/org/ofbiz/base/util/UtilObject.java (original)
+++ ofbiz/trunk/framework/base/src/org/ofbiz/base/util/UtilObject.java Fri Oct 31 15:15:48 2008
@@ -98,7 +98,7 @@
      * the object uses. There is no accurate way to determine the size of an
      * object in memory.</p>
      * @param obj
-     * @return
+     * @return the number of bytes in the serialized object
      */
     public static long getByteCount(Object obj) {
         OutputStreamByteCount osbc = null;

Modified: ofbiz/trunk/framework/base/src/org/ofbiz/base/util/UtilParse.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/base/src/org/ofbiz/base/util/UtilParse.java?rev=709585&r1=709584&r2=709585&view=diff
==============================================================================
--- ofbiz/trunk/framework/base/src/org/ofbiz/base/util/UtilParse.java (original)
+++ ofbiz/trunk/framework/base/src/org/ofbiz/base/util/UtilParse.java Fri Oct 31 15:15:48 2008
@@ -33,7 +33,7 @@
      * return nulls for empty strings, as the entity engine can deal with nulls. This will provide blanks
      * in fields where doubles display. Blank meaning null, vs. 0 which means 0
      * @param doubleString
-     * @return
+     * @return a Double for the parsed value
      */
     public static Double parseDoubleForEntity(String doubleString) throws NumberFormatException {
         if (doubleString == null) {

Modified: ofbiz/trunk/framework/base/src/org/ofbiz/base/util/collections/FlexibleMapAccessor.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/base/src/org/ofbiz/base/util/collections/FlexibleMapAccessor.java?rev=709585&r1=709584&r2=709585&view=diff
==============================================================================
--- ofbiz/trunk/framework/base/src/org/ofbiz/base/util/collections/FlexibleMapAccessor.java (original)
+++ ofbiz/trunk/framework/base/src/org/ofbiz/base/util/collections/FlexibleMapAccessor.java Fri Oct 31 15:15:48 2008
@@ -113,7 +113,7 @@
     /** Given the name based information in this accessor, get the value from the passed in Map.
      *  Supports LocalizedMaps by getting a String or Locale object from the base Map with the key "locale", or by explicit locale parameter.
      * @param base
-     * @return
+     * @return the found value
      */
     public T get(Map<String, ? extends Object> base) {
         return get(base, null);
@@ -124,7 +124,7 @@
      *  Note that the localization functionality is only used when the lowest level sub-map implements the LocalizedMap interface
      * @param base Map to get value from
      * @param locale Optional locale parameter, if null will see if the base Map contains a "locale" key
-     * @return
+     * @return the found value
      */
     public T get(Map<String, ? extends Object> base, Locale locale) {
         if (base == null) {

Modified: ofbiz/trunk/framework/base/src/org/ofbiz/base/util/collections/FlexibleServletAccessor.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/base/src/org/ofbiz/base/util/collections/FlexibleServletAccessor.java?rev=709585&r1=709584&r2=709585&view=diff
==============================================================================
--- ofbiz/trunk/framework/base/src/org/ofbiz/base/util/collections/FlexibleServletAccessor.java (original)
+++ ofbiz/trunk/framework/base/src/org/ofbiz/base/util/collections/FlexibleServletAccessor.java Fri Oct 31 15:15:48 2008
@@ -100,7 +100,7 @@
     /** Based on name get from HttpSession or from List in HttpSession
      * @param session
      * @param expandContext
-     * @return
+     * @return the found value
      */
     public T get(HttpSession session, Map<String, Object> expandContext) {
         AttributeAccessor<T> aa = new AttributeAccessor<T>(name, expandContext, this.attributeName, this.fma, this.needsExpand);
@@ -138,7 +138,7 @@
     /** Based on name remove from ServletRequest or from List in ServletRequest
      * @param request
      * @param expandContext
-     * @return
+     * @return the removed value
      */
     public T remove(ServletRequest request, Map<String, Object> expandContext) {
         AttributeAccessor<T> aa = new AttributeAccessor<T>(name, expandContext, this.attributeName, this.fma, this.needsExpand);
@@ -148,7 +148,7 @@
     /** Based on name remove from HttpSession or from List in HttpSession
      * @param session
      * @param expandContext
-     * @return
+     * @return the removed value
      */
     public T remove(HttpSession session, Map<String, Object> expandContext) {
         AttributeAccessor<T> aa = new AttributeAccessor<T>(name, expandContext, this.attributeName, this.fma, this.needsExpand);
@@ -156,7 +156,7 @@
     }
     
     /** The equals and hashCode methods are imnplemented just case this object is ever accidently used as a Map key *
-     * @return
+     * @return the hashcode
      */    
     public int hashCode() {
         return this.name.hashCode();
@@ -164,7 +164,7 @@
 
     /** The equals and hashCode methods are imnplemented just case this object is ever accidently used as a Map key
      * @param obj
-     * @return
+     * @return whether this object is equal to the passed object
      */    
     public boolean equals(Object obj) {
         if (obj instanceof FlexibleServletAccessor) {
@@ -183,7 +183,7 @@
     }
 
     /** To be used for a string representation of the accessor, returns the original name.
-     * @return
+     * @return the name of this accessor
      */    
     public String toString() {
         return this.name;

Modified: ofbiz/trunk/framework/base/src/org/ofbiz/base/util/string/FlexibleStringExpander.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/base/src/org/ofbiz/base/util/string/FlexibleStringExpander.java?rev=709585&r1=709584&r2=709585&view=diff
==============================================================================
--- ofbiz/trunk/framework/base/src/org/ofbiz/base/util/string/FlexibleStringExpander.java (original)
+++ ofbiz/trunk/framework/base/src/org/ofbiz/base/util/string/FlexibleStringExpander.java Fri Oct 31 15:15:48 2008
@@ -201,7 +201,7 @@
     
     /** Protected helper method.
      * @param original
-     * @return
+     * @return a list of parsed string elements
      */
     protected static List<StrElem> getStrElems(String original) {
         if (original == null || original.length() == 0) {

Modified: ofbiz/trunk/framework/base/src/org/ofbiz/base/util/template/FreeMarkerWorker.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/base/src/org/ofbiz/base/util/template/FreeMarkerWorker.java?rev=709585&r1=709584&r2=709585&view=diff
==============================================================================
--- ofbiz/trunk/framework/base/src/org/ofbiz/base/util/template/FreeMarkerWorker.java (original)
+++ ofbiz/trunk/framework/base/src/org/ofbiz/base/util/template/FreeMarkerWorker.java Fri Oct 31 15:15:48 2008
@@ -138,7 +138,7 @@
     
     /**
      * Renders a template contained in a String.
-     * @param templateId A unique ID for this template - used for caching
+     * @param templateLocation A unique ID for this template - used for caching
      * @param templateString The String containing the template
      * @param context The context Map
      * @param outWriter The Writer to render to
@@ -153,8 +153,7 @@
     
     /**
      * Renders a template from a Reader.
-     * @param templateId A unique ID for this template - used for caching
-     * @param templateReader The Reader that reads the template
+     * @param templateLocation A unique ID for this template - used for caching
      * @param context The context Map
      * @param outWriter The Writer to render to
      */