svn commit: r1850965 - in /db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque: ./ adapter/ avalon/ criteria/ manager/ map/ oid/ om/ sql/ sql/whereclausebuilder/ util/

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

svn commit: r1850965 - in /db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque: ./ adapter/ avalon/ criteria/ manager/ map/ oid/ om/ sql/ sql/whereclausebuilder/ util/

painter
Author: painter
Date: Thu Jan 10 17:21:29 2019
New Revision: 1850965

URL: http://svn.apache.org/viewvc?rev=1850965&view=rev
Log:
JavaDoc cleanup, mvn javadoc:javadoc runs ok now

Modified:
    db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/Database.java
    db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/Torque.java
    db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/TorqueInstance.java
    db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/adapter/MysqlAdapter.java
    db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/adapter/OracleAdapter.java
    db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/avalon/Torque.java
    db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/avalon/TorqueComponent.java
    db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/criteria/Criteria.java
    db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/criteria/Criterion.java
    db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/criteria/FromElement.java
    db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/criteria/SqlEnum.java
    db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/manager/AbstractBaseManager.java
    db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/manager/MethodResultCache.java
    db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/map/ColumnMap.java
    db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/map/DatabaseMap.java
    db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/map/TableMap.java
    db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/oid/AbstractIdGenerator.java
    db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/oid/IDBroker.java
    db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/oid/IDGeneratorFactory.java
    db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/om/ComboKey.java
    db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/om/ObjectKey.java
    db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/sql/SqlBuilder.java
    db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/sql/whereclausebuilder/LikeBuilder.java
    db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/sql/whereclausebuilder/NullValueBuilder.java
    db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/AbstractPeerImpl.java
    db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/BasePeerImpl.java
    db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/LargeSelect.java
    db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/ResultsetSpliterator.java
    db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/SummaryHelper.java
    db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/TorqueConnectionImpl.java

Modified: db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/Database.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/Database.java?rev=1850965&r1=1850964&r2=1850965&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/Database.java (original)
+++ db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/Database.java Thu Jan 10 17:21:29 2019
@@ -122,6 +122,9 @@ public class Database
 
     /**
      * Returns the database map for this database.
+     *
+     * @return the DatabaseMap for this database, or null
+     * if no DatabaseMap exists for this database.
      */
     public DatabaseMap getDatabaseMap()
     {

Modified: db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/Torque.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/Torque.java?rev=1850965&r1=1850964&r2=1850965&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/Torque.java (original)
+++ db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/Torque.java Thu Jan 10 17:21:29 2019
@@ -31,9 +31,10 @@ import org.apache.torque.om.Persistent;
 import org.apache.torque.util.BasePeerImpl;
 
 /**
+ * <p>
  * A static facade wrapper around the Torque implementation (which is in
  * {@link org.apache.torque.TorqueInstance}).
- * <br/>
+ * </p>
  *
  * @author <a href="mailto:[hidden email]">Daniel Rall</a>
  * @author <a href="mailto:[hidden email]">Magn�s ��r Torfason</a>
@@ -189,6 +190,7 @@ public final class Torque
     /**
      * This method returns a Manager for the given name.
      *
+     * @param <T> the type of the manager class
      * @param name name of the manager.
      *
      * @return The requested Manager.
@@ -208,6 +210,7 @@ public final class Torque
      * This methods returns either the Manager from the configuration file,
      * or the default one provided by the generated code.
      *
+     * @param <T> the type of the manager class
      * @param name name of the manager.
      * @param defaultClassName the class to use if name has not been configured.
      *
@@ -229,6 +232,7 @@ public final class Torque
     /**
      * This method registers a PeerImpl for a given class.
      *
+     * @param <T> the type of the OM class
      * @param omClass the class of the associated OM object
      * @param peerInstance PeerImpl instance
      */
@@ -240,6 +244,8 @@ public final class Torque
     /**
      * This method returns a PeerImpl for the given class.
      *
+     * @param <T> the type of the OM class
+     * @param <P> the type of the peer instance class
      * @param omClass the class of the associated OM object
      * @return a PeerImpl instance
      */
@@ -466,13 +472,16 @@ public final class Torque
     /**
      * Returns a Map containing all Databases registered to Torque.
      * The key of the Map is the name of the database, and the value is the
-     * database instance. <br/>
+     * database instance.
+     *
+     * <p>
      * Note that in the very special case where a new database which
      * is not configured in Torque's configuration gets known to Torque
      * at a later time, the returned map may change, and there is no way to
      * protect you against this. However, Databases should be initialized
      * in the init() method, so this will not happen if Torque is used
      * properly.
+     * </p>
      *
      * @return a Map containing all Databases known to Torque, never null.
      *

Modified: db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/TorqueInstance.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/TorqueInstance.java?rev=1850965&r1=1850964&r2=1850965&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/TorqueInstance.java (original)
+++ db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/TorqueInstance.java Thu Jan 10 17:21:29 2019
@@ -773,6 +773,7 @@ public class TorqueInstance
     /**
      * This method returns a Manager for the given name.
      *
+     * @param <T> the type of the manager class
      * @param name name of the manager
      * @return a Manager
      */
@@ -791,6 +792,7 @@ public class TorqueInstance
      * This methods returns either the Manager from the configuration file,
      * or the default one provided by the generated code.
      *
+     * @param <T> the type of the manager class
      * @param name name of the manager.
      * @param defaultClassName the class to use if name has not been configured.
      *
@@ -825,6 +827,8 @@ public class TorqueInstance
     /**
      * This method registers a PeerImpl for a given class.
      *
+     * @param <T> the type of the OM class
+     * @param <T> the type of the peerInstance class
      * @param omClass the class of the associated OM object
      * @param peerInstance PeerImpl instance
      */
@@ -835,7 +839,9 @@ public class TorqueInstance
 
     /**
      * This method returns a PeerImpl for the given class.
-     *
+     *  
+     * @param <T> the type of the OM class
+     * @param <P> the type of the peerInstance class
      * @param omClass the class of the associated OM object
      * @return a PeerImpl instance
      */
@@ -1211,13 +1217,18 @@ public class TorqueInstance
     }
 
     /**
+     * <p>
      * Returns a Map containing all Databases registered to Torque.
      * The key of the Map is the name of the database, and the value is the
-     * database instance. <br/>
+     * database instance.
+     * </p>
+     *
+     * <p>
      * Note that in the very special case where a new database which
      * is not configured in Torque's configuration gets known to Torque
      * at a later time, the returned map may change, and there is no way to
      * protect you against this.
+     * </p>
      *
      * @return a Map containing all Databases known to Torque, never null.
      *

Modified: db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/adapter/MysqlAdapter.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/adapter/MysqlAdapter.java?rev=1850965&r1=1850964&r2=1850965&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/adapter/MysqlAdapter.java (original)
+++ db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/adapter/MysqlAdapter.java Thu Jan 10 17:21:29 2019
@@ -33,7 +33,7 @@ import org.apache.torque.sql.Query;
  *
  * <P><a href="http://www.mysql.com/">http://www.mysql.com/</a>
  * <p>"jdbc:mysql://" + DB_HOST + "/" + DB_NAME + "?user=" +
- * DB_USER + "&password=" + DB_PASS;
+ * DB_USER + "&amp;password=" + DB_PASS;
  *
  * @author <a href="mailto:[hidden email]">Jon S. Stevens</a>
  * @author <a href="mailto:[hidden email]">Brett McLaughlin</a>

Modified: db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/adapter/OracleAdapter.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/adapter/OracleAdapter.java?rev=1850965&r1=1850964&r2=1850965&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/adapter/OracleAdapter.java (original)
+++ db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/adapter/OracleAdapter.java Thu Jan 10 17:21:29 2019
@@ -87,16 +87,17 @@ public class OracleAdapter extends Abstr
     }
 
     /**
+     * @see org.apache.torque.adapter.AbstractAdapter#getIDMethodSQL(java.lang.Object)
+     *
      * Returns the next key from a sequence.  Uses the following
      * implementation:
      *
-     * <blockquote><code><pre>
-     * select sequenceName.nextval from dual
-     * </pre></code></blockquote>
+     * <pre>
+     * <code>select sequenceName.nextval from dual</code>
+     * </pre>
      *
-     * @param sequenceName The name of the sequence (should be of type
-     * <code>String</code>).
-     * @return SQL to retreive the next database key.
+     * @param sequenceName The name of the sequence (should be of type <code>String</code>).
+     * @return SQL to retrieve the next database key.
      * @see org.apache.torque.adapter.Adapter#getIDMethodSQL(Object)
      */
     @Override
@@ -145,8 +146,8 @@ public class OracleAdapter extends Abstr
      *          SELECT A.*, rownum as TORQUE$ROWNUM FROM (
      *                  query
      *          ) A
-     *     ) B WHERE B.TORQUE$ROWNUM > offset AND B.TORQUE$ROWNUM
-     *     <= offset + limit
+     *     ) B WHERE B.TORQUE$ROWNUM &gt; offset AND B.TORQUE$ROWNUM
+     *     &lt;= offset + limit
      * </pre>
      *
      * @param query The query to modify

Modified: db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/avalon/Torque.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/avalon/Torque.java?rev=1850965&r1=1850964&r2=1850965&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/avalon/Torque.java (original)
+++ db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/avalon/Torque.java Thu Jan 10 17:21:29 2019
@@ -70,6 +70,7 @@ extends Component
     /**
      * This method returns a Manager for the given name.
      *
+     * @param <T> manager class type
      * @param name name of the manager
      * @return a Manager
      */
@@ -79,6 +80,7 @@ extends Component
      * This methods returns either the Manager from the configuration file,
      * or the default one provided by the generated code.
      *
+     * @param <T> manager class type
      * @param name name of the manager
      * @param defaultClassName the class to use if name has not been configured
      * @return a Manager
@@ -196,11 +198,14 @@ extends Component
     /**
      * Returns a Map containing all Databases registered to Torque.
      * The key of the Map is the name of the database, and the value is the
-     * database instance. <br/>
+     * database instance.
+     *  
+     * <p>
      * Note that in the very special case where a new database which
      * is not configured in Torque's configuration gets known to Torque
      * at a later time, the returned map may change, and there is no way to
      * protect you against this.
+     * </p>
      *
      * @return a Map containing all Databases known to Torque, never null.
      * @throws TorqueException if Torque is not yet initialized.

Modified: db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/avalon/TorqueComponent.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/avalon/TorqueComponent.java?rev=1850965&r1=1850964&r2=1850965&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/avalon/TorqueComponent.java (original)
+++ db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/avalon/TorqueComponent.java Thu Jan 10 17:21:29 2019
@@ -83,15 +83,15 @@ ThreadSafe
 
     /**
      * Convenience method to provide the Avalon logger the way AbstractLogEnabled does.
+     * @return Logger instance
      */
     public Logger getLogger()
     {
         return logger;
     }
 
-    /**
-     * @see
-     * org.apache.avalon.framework.configuration.Configurable#configure(org.apache.avalon.framework.configuration.Configuration)
+    /* (non-Javadoc)
+     * @see org.apache.avalon.framework.configuration.Configurable#configure(org.apache.avalon.framework.configuration.Configuration)
      */
     @Override
     public void configure(Configuration configuration)
@@ -124,8 +124,8 @@ ThreadSafe
         this.configFile = configurationFile;
     }
 
-    /**
-     * @see org.apache.avalon.framework.context.Contextualizable
+    /* (non-Javadoc)
+     * @see org.apache.avalon.framework.context.Contextualizable#contextualize(org.apache.avalon.framework.context.Context)
      */
     @Override
     public void contextualize(Context context)
@@ -154,7 +154,7 @@ ThreadSafe
         }
     }
 
-    /**
+    /* (non-Javadoc)
      * @see org.apache.avalon.framework.activity.Initializable#initialize()
      */
     @Override
@@ -196,7 +196,7 @@ ThreadSafe
         }
     }
 
-    /**
+    /* (non-Javadoc)
      * @see org.apache.avalon.framework.activity.Disposable#dispose()
      */
     @Override

Modified: db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/criteria/Criteria.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/criteria/Criteria.java?rev=1850965&r1=1850964&r2=1850965&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/criteria/Criteria.java (original)
+++ db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/criteria/Criteria.java Thu Jan 10 17:21:29 2019
@@ -347,7 +347,7 @@ public class Criteria implements Seriali
      *
      * @param alias the alias for the table name.
      * @param table the table name as known in the database.
-     *
+     * @return the Criteria object
      * @throws TorqueRuntimeException if this operation is performed on a
      *         Criteria composed of set parts (e.g. union, intersect, except).
      */
@@ -363,7 +363,7 @@ public class Criteria implements Seriali
      *
      * @param alias the alias for the subselect.
      * @param subselect the Criteria for the subselect.
-     *
+     * @return the Criteria object
      * @throws TorqueRuntimeException if this operation is performed on a
      *         Criteria composed of set parts (e.g. union, intersect, except).
      */
@@ -600,7 +600,7 @@ public class Criteria implements Seriali
     /**
      * Adds a join to the criteria, E.g. to create the condition
      * <p>
-     * PROJECT LEFT JOIN FOO ON PROJECT.PROJECT_ID<>FOO.PROJECT_ID
+     * PROJECT LEFT JOIN FOO ON PROJECT.PROJECT_ID &lt;&gt; FOO.PROJECT_ID
      * <p> use <p>
      * <code>
      * criteria.addJoin(
@@ -1047,6 +1047,7 @@ public class Criteria implements Seriali
     /**
      * Adds a table to the from clause, not using a joinType or joinCondition.
      *
+     * @param tableName the table name
      * @return the modified Criteria object.
      *
      * @throws TorqueRuntimeException if this operation is performed on a
@@ -1062,6 +1063,7 @@ public class Criteria implements Seriali
     /**
      * Adds a new Element to the from clause.
      *
+     * @param fromElement the element to add from
      * @return the modified Criteria object.
      *
      * @throws TorqueRuntimeException if this operation is performed on a

Modified: db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/criteria/Criterion.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/criteria/Criterion.java?rev=1850965&r1=1850964&r2=1850965&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/criteria/Criterion.java (original)
+++ db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/criteria/Criterion.java Thu Jan 10 17:21:29 2019
@@ -378,6 +378,9 @@ public class Criterion implements Serial
      *
      * @param criterion the criterion to and with this criterion,
      *        not null.
+     *        
+     * @return the modified Criteria object.
+     *
      */
     public Criterion and(final Criterion criterion)
     {
@@ -391,6 +394,8 @@ public class Criterion implements Serial
      *
      * @param criterion the criterion to and with this criterion,
      *        not null.
+     *        
+     * @return the modified Criteria object.
      */
     public Criterion or(final Criterion criterion)
     {
@@ -438,6 +443,8 @@ public class Criterion implements Serial
     /**
      * Appends a debug String representation of the Criterion
      * onto the String builder.
+     *
+     * @param sb the string representation
      */
     public void appendTo(final StringBuilder sb)
     {
@@ -516,7 +523,9 @@ public class Criterion implements Serial
         return builder.toString();
     }
 
-    /**
+    /* (non-Javadoc)
+     * @see java.lang.Object#equals(java.lang.Object)
+     *
      * This method checks another Criteria.Criterion to see if they contain
      * the same attributes.
      */
@@ -550,7 +559,9 @@ public class Criterion implements Serial
         return equalsBuilder.isEquals();
     }
 
-    /**
+    /* (non-Javadoc)
+     * @see java.lang.Object#hashCode()
+     *
      * Returns a hash code value for the object.
      */
     @Override

Modified: db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/criteria/FromElement.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/criteria/FromElement.java?rev=1850965&r1=1850964&r2=1850965&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/criteria/FromElement.java (original)
+++ db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/criteria/FromElement.java Thu Jan 10 17:21:29 2019
@@ -57,10 +57,9 @@ public class FromElement implements Seri
     /**
      * Constructor with join type null and joinCondition null.
      *
-     * @param tableName the table name, might contain an appended alias name
-     *        e.g. <br />
-     *        table_1<br />
-     *        table_1 alias_for_table_1
+     * @param tableName the table name, might contain an appended alias name, e.g.
+     * <p> table_1 </p>
+     *      <p> table_1 alias_for_table_1 </p>
      */
     public FromElement(final String tableName)
     {
@@ -72,9 +71,9 @@ public class FromElement implements Seri
      *
      * @param fromExpression the expression to add to the from clause,
      *        e.g. a simple table name or a table name with an alias,
-     *        e.g. <br />
-     *        table_1<br />
-     *        table_1 alias_for_table_1
+     * <p> table_1 </p>
+     *      <p> table_1 alias_for_table_1 </p>
+     *      
      * @param joinType the type of the join, e.g. JoinType.LEFT_JOIN,
      *        or null if no excplicit join is wanted
      * @param joinCondition the join condition,
@@ -96,9 +95,9 @@ public class FromElement implements Seri
      *
      * @param fromExpression the expression to add to the from clause,
      *        e.g. a simple table name or a table name with an alias,
-     *        e.g. <br />
-     *        table_1<br />
-     *        table_1 alias_for_table_1
+     * <p> table_1 </p>
+     *      <p> table_1 alias_for_table_1 </p>
+     *      
      * @param joinType the type of the join, e.g. JoinType.LEFT_JOIN,
      *        or null if no explicit join is wanted
      * @param joinCondition the join condition,
@@ -130,9 +129,9 @@ public class FromElement implements Seri
      *
      * @param fromExpression the expression to add to the from clause,
      *        e.g. a simple table name or a table name with an alias,
-     *        e.g. <br />
-     *        table_1<br />
-     *        table_1 alias_for_table_1
+     * <p> table_1 </p>
+     *      <p> table_1 alias_for_table_1 </p>
+     *      
      * @param joinType the type of the join, e.g. JoinType.LEFT_JOIN,
      *        or null if no explicit join is wanted
      * @param joinCondition the join condition,
@@ -176,10 +175,9 @@ public class FromElement implements Seri
      * Returns the fromExpression, which might e.g. be a simple table name or
      *         a table name or a subquery with an alias appended.
      *
-     * @return the tablename, might contain an appended alias name,
-     *         e.g. <br />
-     *         table_1<br />
-     *         table_1 alias_for_table_1
+     * @return the tablename, might contain an appended alias name, e.g.
+     * <p> table_1 </p>
+     *      <p> table_1 alias_for_table_1 </p>
      *
      */
     public String getFromExpression()

Modified: db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/criteria/SqlEnum.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/criteria/SqlEnum.java?rev=1850965&r1=1850964&r2=1850965&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/criteria/SqlEnum.java (original)
+++ db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/criteria/SqlEnum.java Thu Jan 10 17:21:29 2019
@@ -73,22 +73,22 @@ public final class SqlEnum implements ja
     /** SQL Expression "=". */
     public static final SqlEnum EQUAL =
             new SqlEnum("=", 2);
-    /** SQL Expression "<>". */
+    /** SQL Expression "&lt;&gt;". */
     public static final SqlEnum NOT_EQUAL =
             new SqlEnum("<>", 2);
     /** SQL Expression "!=". */
     public static final SqlEnum ALT_NOT_EQUAL =
             new SqlEnum("!=", 2);
-    /** SQL Expression ">". */
+    /** SQL Expression "&gt;". */
     public static final SqlEnum GREATER_THAN =
             new SqlEnum(">", 2);
-    /** SQL Expression "<". */
+    /** SQL Expression "&lt;". */
     public static final SqlEnum LESS_THAN =
             new SqlEnum("<", 2);
-    /** SQL Expression ">=". */
+    /** SQL Expression "&gt;=". */
     public static final SqlEnum GREATER_EQUAL =
             new SqlEnum(">=", 2);
-    /** SQL Expression "<=". */
+    /** SQL Expression "&lt;=". */
     public static final SqlEnum LESS_EQUAL =
             new SqlEnum("<=", 2);
     /** SQL Expression " LIKE ". */

Modified: db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/manager/AbstractBaseManager.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/manager/AbstractBaseManager.java?rev=1850965&r1=1850964&r2=1850965&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/manager/AbstractBaseManager.java (original)
+++ db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/manager/AbstractBaseManager.java Thu Jan 10 17:21:29 2019
@@ -401,6 +401,7 @@ implements Serializable
      * Gets a list of om's based on id's.
      *
      * @param ids a <code>List</code> of <code>ObjectKey</code>'s.
+     * @param fromCache boolean flag if we are to use the cache
      *
      * @return a <code>List</code> value, not null.
      *
@@ -561,6 +562,7 @@ implements Serializable
     /**
      * Notify all listeners associated to the column that an object has changed
      *
+     * @param <TT> column type class
      * @param column the column related to the listeners
      * @param oldOm the previous object, null if the object has been added
      * @param om the new object, null if the object has been removed
@@ -601,8 +603,8 @@ implements Serializable
     /**
      * helper methods for the Serializable interface
      *
-     * @param out
-     * @throws IOException
+     * @param out the output stream
+     * @throws IOException if output stream not found
      */
     private void writeObject(final java.io.ObjectOutputStream out)
             throws IOException
@@ -614,8 +616,8 @@ implements Serializable
      * Helper methods for the <code>Serializable</code> interface.
      *
      * @param in The stream to read a <code>Serializable</code> from.
-     * @throws IOException
-     * @throws ClassNotFoundException
+     * @throws IOException if input stream cannot be read
+     * @throws ClassNotFoundException if the class is not found
      */
     private void readObject(final ObjectInputStream in)
             throws IOException, ClassNotFoundException

Modified: db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/manager/MethodResultCache.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/manager/MethodResultCache.java?rev=1850965&r1=1850964&r2=1850965&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/manager/MethodResultCache.java (original)
+++ db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/manager/MethodResultCache.java Thu Jan 10 17:21:29 2019
@@ -134,6 +134,7 @@ public class MethodResultCache
     /**
      * Get an object from the method cache
      *
+     * @param <T> type of the instance class
      * @param instanceOrClass the Object on which the method is invoked.  if
      * the method is static, a String representing the class name is used.
      * @param method the method name
@@ -157,6 +158,7 @@ public class MethodResultCache
     /**
      * Put an object into the method cache
      *
+     * @param <T> type of the instance class
      * @param value the object to put into the cache
      * @param instanceOrClass the Object on which the method is invoked.  if
      * the method is static, a String representing the class name is used.
@@ -196,6 +198,7 @@ public class MethodResultCache
     /**
      * Remove object from method cache
      *
+     * @param <T> type of the instance class
      * @param instanceOrClass the Object on which the method is invoked.  if
      * the method is static, a String representing the class name is used.
      * @param method the method name

Modified: db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/map/ColumnMap.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/map/ColumnMap.java?rev=1850965&r1=1850964&r2=1850965&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/map/ColumnMap.java (original)
+++ db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/map/ColumnMap.java Thu Jan 10 17:21:29 2019
@@ -29,7 +29,7 @@ import org.apache.torque.Column;
 /**
  * ColumnMap is used to model a column of a table in a database.
  * <p>
- * Note that this information should be set via the <Table>MapBuilder class and
+ * Note that this information should be set via the <code>TableMapBuilder</code> class and
  * not changed by applications. The set methods are only public because this
  * class needs them.
  *
@@ -104,7 +104,7 @@ public class ColumnMap extends OptionSup
 
     /** Associated of inheritance maps. */
     private final Map<String, InheritanceMap> inheritanceMaps
-    = Collections.synchronizedMap(
+     = Collections.synchronizedMap(
             new LinkedHashMap<String, InheritanceMap>());
 
     /** Java naming method the generator used. */

Modified: db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/map/DatabaseMap.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/map/DatabaseMap.java?rev=1850965&r1=1850964&r2=1850965&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/map/DatabaseMap.java (original)
+++ db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/map/DatabaseMap.java Thu Jan 10 17:21:29 2019
@@ -67,13 +67,13 @@ public class DatabaseMap extends OptionS
 
     /** Error Message for class not found. */
     private static final String ERROR_MESSAGES_CLASS_NOT_FOUND
-    = "Invalid Torque OM setup for Database \"{0}\".\n"
+     = "Invalid Torque OM setup for Database \"{0}\".\n"
             + "Database Map initialization class, \"{1}\"," + " "
             + "could not be found in your classpath.";
 
     /** Error Message for dependent class not found. */
     private static final String ERROR_MESSAGES_DEPENDENT_CLASS_NOT_FOUND
-    = "Invalid Torque OM setup for Database \"{0}\".\n"
+     = "Invalid Torque OM setup for Database \"{0}\".\n"
             + "A class that the Database Map initialization class, \"{1}\", "
             + "depends on could not be found.";
 
@@ -96,7 +96,7 @@ public class DatabaseMap extends OptionS
 
     /** Name of the tables in the database. */
     private final Map<String, TableMap> tables
-    = Collections.synchronizedMap(new LinkedHashMap<String, TableMap>());
+     = Collections.synchronizedMap(new LinkedHashMap<String, TableMap>());
 
     /** The id Table. */
     private TableMap idTable = null;
@@ -106,6 +106,8 @@ public class DatabaseMap extends OptionS
 
     /**
      * Constructs a new DatabaseMap.
+     * @param database the databsae to map
+     * @throws NullPointerException if the database is not provided
      */
     public DatabaseMap(final Database database)
     {

Modified: db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/map/TableMap.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/map/TableMap.java?rev=1850965&r1=1850964&r2=1850965&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/map/TableMap.java (original)
+++ db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/map/TableMap.java Thu Jan 10 17:21:29 2019
@@ -321,6 +321,7 @@ public class TableMap extends OptionSupp
     /**
      * Get the information used to generate a primary key
      *
+     * @param idMethod <code>IDMethod</code> used to generate a primary key
      * @return An Object.
      */
     public Object getPrimaryKeyMethodInfo(IDMethod idMethod)

Modified: db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/oid/AbstractIdGenerator.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/oid/AbstractIdGenerator.java?rev=1850965&r1=1850964&r2=1850965&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/oid/AbstractIdGenerator.java (original)
+++ db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/oid/AbstractIdGenerator.java Thu Jan 10 17:21:29 2019
@@ -172,6 +172,7 @@ public abstract class AbstractIdGenerato
     /**
      * Returns the last ID used by this connection.
      *
+     * @param <T> the id object class
      * @param connection A Connection.
      * @param keyInfo an Object that contains additional info.
      * @param mapper The RecordMapper that maps from a ResultSet to the
@@ -221,7 +222,7 @@ public abstract class AbstractIdGenerato
      *
      * @return the SQL to retrieve the next id.
      *
-     * @throws TorqueException
+     * @throws TorqueException if a database error occurs.
      */
     public String getIdSql(final Object keyInfo) throws TorqueException
     {

Modified: db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/oid/IDBroker.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/oid/IDBroker.java?rev=1850965&r1=1850964&r2=1850965&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/oid/IDBroker.java (original)
+++ db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/oid/IDBroker.java Thu Jan 10 17:21:29 2019
@@ -261,6 +261,9 @@ public class IDBroker implements Runnabl
     }
 
     /**
+     *
+     * @see org.apache.torque.oid.IdGenerator#getIdAsInt(java.sql.Connection, java.lang.Object)
+     *
      * Returns an id as a primitive int.  Note this method does not
      * require a Connection, it just implements the KeyGenerator
      * interface.  if a Connection is needed one will be requested.
@@ -270,7 +273,7 @@ public class IDBroker implements Runnabl
      * @param connection A Connection.
      * @param tableName an Object that contains additional info.
      * @return An int with the value for the id.
-     * @exception Exception Database error.
+     * @exception TorqueException Database error.
      */
     @Override
     public int getIdAsInt(Connection connection, Object tableName)
@@ -281,6 +284,8 @@ public class IDBroker implements Runnabl
 
 
     /**
+     * @see org.apache.torque.oid.IdGenerator#getIdAsLong(java.sql.Connection, java.lang.Object)
+     *
      * Returns an id as a primitive long. Note this method does not
      * require a Connection, it just implements the KeyGenerator
      * interface.  if a Connection is needed one will be requested.
@@ -290,7 +295,7 @@ public class IDBroker implements Runnabl
      * @param connection A Connection.
      * @param tableName a String that identifies a table.
      * @return A long with the value for the id.
-     * @exception Exception Database error.
+     * @exception TorqueException Database error.
      */
     @Override
     public long getIdAsLong(Connection connection, Object tableName)
@@ -309,7 +314,7 @@ public class IDBroker implements Runnabl
      * @param connection A Connection.
      * @param tableName a String that identifies a table..
      * @return A BigDecimal id.
-     * @exception Exception Database error.
+     * @exception TorqueException Database error.
      */
     @Override
     public BigDecimal getIdAsBigDecimal(Connection connection,
@@ -330,7 +335,7 @@ public class IDBroker implements Runnabl
      * @param connection A Connection should be null.
      * @param tableName a String that identifies a table.
      * @return A String id
-     * @exception Exception Database error.
+     * @exception TorqueException Database error.
      */
     @Override
     public String getIdAsString(Connection connection, Object tableName)

Modified: db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/oid/IDGeneratorFactory.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/oid/IDGeneratorFactory.java?rev=1850965&r1=1850964&r2=1850965&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/oid/IDGeneratorFactory.java (original)
+++ db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/oid/IDGeneratorFactory.java Thu Jan 10 17:21:29 2019
@@ -66,6 +66,7 @@ public final class IDGeneratorFactory
      * Returns <code>null</code> for unknown types.
      *
      * @param adapter The type of adapter to create an ID generator for.
+     * @param name name of the adapter
      *
      * @return The appropriate ID generator (possibly <code>null</code>).
      */

Modified: db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/om/ComboKey.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/om/ComboKey.java?rev=1850965&r1=1850964&r2=1850965&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/om/ComboKey.java (original)
+++ db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/om/ComboKey.java Thu Jan 10 17:21:29 2019
@@ -317,9 +317,15 @@ public class ComboKey extends ObjectKey<
 
     /**
      * A String that may consist of one section or multiple sections
-     * separated by a colon. <br/>
-     * Each Key is represented by <code>[type N|S|D][value][:]</code>. <p/>
-     * Example: <br/>
+     * separated by a colon.
+     *
+     * <p>
+     * Each Key is represented by <code>[type N|S|D][value][:]</code>.
+     *
+     * <p>
+     * <b>Example:</b>
+     *
+     * <p>
      * the ComboKey(StringKey("key1"), NumberKey(2)) is represented as
      * <code><b>Skey1:N2:</b></code>
      *

Modified: db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/om/ObjectKey.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/om/ObjectKey.java?rev=1850965&r1=1850964&r2=1850965&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/om/ObjectKey.java (original)
+++ db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/om/ObjectKey.java Thu Jan 10 17:21:29 2019
@@ -161,6 +161,7 @@ public abstract class ObjectKey<T> imple
     /**
      * Sets the internal representation to the same object used by key.
      *
+     * @param <O> the key type
      * @param key the key value
      */
     public <O extends ObjectKey<T>> void setValue(O key)

Modified: db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/sql/SqlBuilder.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/sql/SqlBuilder.java?rev=1850965&r1=1850964&r2=1850965&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/sql/SqlBuilder.java (original)
+++ db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/sql/SqlBuilder.java Thu Jan 10 17:21:29 2019
@@ -722,8 +722,9 @@ public final class SqlBuilder
      *
      * @param name the name to unqualify.
      *        If null is passed in, null is returned.
-     *
+     * @param dbName name of the database
      * @return The unqualified name.
+     * @throws TorqueException if the name cannot be determined.
      */
     public static String getUnqualifiedName(
             final String name,
@@ -824,12 +825,14 @@ public final class SqlBuilder
     /**
      * Returns the database name of a column.
      *
-     * @param tableName the name of a table or the alias for a table.
+     * @param columnToResolve the name of a column or the alias for a column.
      * @param criteria a criteria object to resolve a possible alias.
      *
      * @return either the tablename itself if tableOrAliasName is not an alias,
      *         or a String of the form "tableName tableOrAliasName"
      *         if tableOrAliasName is an alias for a table name
+     *        
+     * @throws TorqueException if the column is not found.
      */
     static Column resolveAliasAndAsColumnAndSchema(
             final Column columnToResolve,

Modified: db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/sql/whereclausebuilder/LikeBuilder.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/sql/whereclausebuilder/LikeBuilder.java?rev=1850965&r1=1850964&r2=1850965&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/sql/whereclausebuilder/LikeBuilder.java (original)
+++ db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/sql/whereclausebuilder/LikeBuilder.java Thu Jan 10 17:21:29 2019
@@ -43,9 +43,9 @@ public class LikeBuilder extends Abstrac
      * as well as single character wildcards, _ and ?.  These
      * characters can be escaped with \.
      *
-     * e.g. criteria = "fre%" -> columnName LIKE 'fre%'
-     *                        -> UPPER(columnName) LIKE UPPER('fre%')
-     *      criteria = "50\%" -> columnName = '50%'
+     * e.g. criteria = "fre%" -&gt; columnName LIKE 'fre%'
+     *                        -&gt; UPPER(columnName) LIKE UPPER('fre%')
+     *      criteria = "50\%" -&gt; columnName = '50%'
      *
      * @param whereClausePart the part of the where clause to build.
      *        Can be modified in this method.

Modified: db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/sql/whereclausebuilder/NullValueBuilder.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/sql/whereclausebuilder/NullValueBuilder.java?rev=1850965&r1=1850964&r2=1850965&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/sql/whereclausebuilder/NullValueBuilder.java (original)
+++ db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/sql/whereclausebuilder/NullValueBuilder.java Thu Jan 10 17:21:29 2019
@@ -29,7 +29,7 @@ import org.apache.torque.sql.WhereClause
 
 /**
  * Builds a PreparedStatementPart from a WhereClauseExpression which
- * rhs is null and which has one of the comparison opertator =, <>, or !=,
+ * rhs is null and which has one of the comparison opertator =, &lt;&gt;, or !=,
  * or which operator is SqlEnum.ISNULL or SqlEnum.ISNOTNULL
 
  *
@@ -39,7 +39,7 @@ public class NullValueBuilder extends Ab
 {
     /**
      * Builds a PreparedStatementPart from a WhereClauseExpression which
-     * rhs is null and which has one of the comparison opertator =, <>, or !=.
+     * rhs is null and which has one of the comparison opertator =, &lt;&gt;, or !=.
      *
      * @param whereClausePart the part of the where clause to build.
      *        Can be modified in this method.

Modified: db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/AbstractPeerImpl.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/AbstractPeerImpl.java?rev=1850965&r1=1850964&r2=1850965&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/AbstractPeerImpl.java (original)
+++ db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/AbstractPeerImpl.java Thu Jan 10 17:21:29 2019
@@ -69,6 +69,7 @@ public abstract class AbstractPeerImpl<T
      * Build a Criteria object from the data object for this peer.
      *
      * @param obj the object to build the criteria from, not null.
+     * @return Criteria object
      */
     public abstract Criteria buildCriteria(T obj);
 
@@ -77,6 +78,7 @@ public abstract class AbstractPeerImpl<T
      * skipping all binary columns.
      *
      * @param obj the object to build the criteria from, not null.
+     * @return Criteria object
      */
     public abstract Criteria buildSelectCriteria(T obj);
 
@@ -88,6 +90,7 @@ public abstract class AbstractPeerImpl<T
      * it must be overridden in the generated code.
      *
      * @param pk the primary key value to build the criteria from, not null.
+     * @return Criteria object
      */
     public Criteria buildCriteria(ObjectKey<?> pk)
     {
@@ -101,6 +104,9 @@ public abstract class AbstractPeerImpl<T
      * value. Also, columns which have the useDatabaseDefaultValue
      * flag set to true are also not added to the returned object
      * if they still have their initial value.
+     *
+     * @param obj the object to build the column values from
+     * @return ColumnValues object
      *
      * @throws TorqueException if the table map cannot be retrieved
      *         (should not happen).
@@ -111,6 +117,7 @@ public abstract class AbstractPeerImpl<T
      * Selects objects from the database which have
      * the same content as the passed object.
      *
+     * @param obj the data object
      * @return The list of selected objects, not null.
      *
      * @throws TorqueException Any exceptions caught during processing will be
@@ -124,7 +131,8 @@ public abstract class AbstractPeerImpl<T
     /**
      * Selects at most one object from the database
      * which has the same content as the passed object.
-     *
+     *
+     * @param obj the data object
      * @return the selected Object, or null if no object was selected.
      *
      * @throws TorqueException Any exceptions caught during processing will be
@@ -169,7 +177,9 @@ public abstract class AbstractPeerImpl<T
 
     /**
      * Method to do inserts
-     *
+     *
+     * @param obj the data object
+     *
      * @throws TorqueException Any exceptions caught during processing will be
      *         rethrown wrapped into a TorqueException.
      */
@@ -188,7 +198,7 @@ public abstract class AbstractPeerImpl<T
      * Method to do inserts.  This method is to be used during a transaction,
      * otherwise use the doInsert(T) method.  It will take
      * care of the connection details internally.
-     *
+     *
      * @param obj the data object to insert into the database.
      * @param con the connection to use
      * @throws TorqueException Any exceptions caught during processing will be

Modified: db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/BasePeerImpl.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/BasePeerImpl.java?rev=1850965&r1=1850964&r2=1850965&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/BasePeerImpl.java (original)
+++ db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/BasePeerImpl.java Thu Jan 10 17:21:29 2019
@@ -934,6 +934,7 @@ public class BasePeerImpl<T> implements
     /**
      * Selects rows from a database an maps them to objects.
      *
+     * @param <TT> Object type class
      * @param criteria A Criteria specifying the records to select, not null.
      * @param mapper The mapper creating the objects from the resultSet,
      *        not null.
@@ -1025,6 +1026,7 @@ public class BasePeerImpl<T> implements
     /**
      * Selects rows from a database an maps them to objects.
      *
+     * @param <TT> Object type class
      * @param query the sql query to execute, not null.
      * @param mapper The mapper creating the objects from the resultSet,
      *        not null.
@@ -1059,6 +1061,7 @@ public class BasePeerImpl<T> implements
     /**
      * Selects rows from a database an maps them to objects.
      *
+     * @param <TT> Object type class
      * @param query the SQL Query to execute, not null.
      * @param mapper The mapper creating the objects from the resultSet,
      *        not null.
@@ -1086,6 +1089,7 @@ public class BasePeerImpl<T> implements
      * All resources used by this method will be closed when the stream is
      * closed.
      *
+     * @param <TT> Object type class
      * @param query the SQL Query to execute, not null.
      * @param mapper The mapper creating the objects from the resultSet,
      *        not null.
@@ -1129,6 +1133,7 @@ public class BasePeerImpl<T> implements
     /**
      * Performs a SQL <code>select</code> using a PreparedStatement.
      *
+     * @param <TT> Object type class
      * @param criteria A Criteria specifying the records to select, not null.
      * @param mapper The mapper creating the objects from the resultSet,
      *        not null.
@@ -1166,6 +1171,7 @@ public class BasePeerImpl<T> implements
      * All resources used by this method will be closed when the stream is
      * closed.
      *
+     * @param <TT> Object type class
      * @param criteria A Criteria specifying the records to select, not null.
      * @param mapper The mapper creating the objects from the resultSet,
      *        not null.
@@ -1233,6 +1239,7 @@ public class BasePeerImpl<T> implements
     /**
      * Selects at most a single row from a database an maps them to objects.
      *
+     * @param <TT> Object type class
      * @param criteria A Criteria specifying the records to select, not null.
      * @param mapper The mapper creating the objects from the resultSet,
      *        not null.
@@ -1263,6 +1270,7 @@ public class BasePeerImpl<T> implements
     /**
      * Selects at most a single row from a database an maps them to objects.
      *
+     * @param <TT> Object type class
      * @param criteria A Criteria specifying the records to select, not null.
      * @param mapper The mapper creating the objects from the resultSet,
      *        not null.
@@ -2014,6 +2022,7 @@ public class BasePeerImpl<T> implements
      * if it is not already set.
      *
      * @param crit the criteria to set the database name in, not null.
+     * @throws TorqueException if unable to set the database name
      */
     protected void setDbName(final Criteria crit)
             throws TorqueException

Modified: db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/LargeSelect.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/LargeSelect.java?rev=1850965&r1=1850964&r2=1850965&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/LargeSelect.java (original)
+++ db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/LargeSelect.java Thu Jan 10 17:21:29 2019
@@ -819,6 +819,7 @@ public class LargeSelect<T> implements R
 
     /**
      * Retrieve the more pages/records indicator.
+     * @return string indicating if there are more pages/records
      */
     public String getMoreIndicator()
     {
@@ -842,6 +843,9 @@ public class LargeSelect<T> implements R
      * Retrieves the multiplier that will be used to compute the memory limit
      * when a constructor with no memory page limit is used - the memory limit
      * will be this number multiplied by the page size.
+     *
+     * @return memoryPageLimit the maximum number of pages to be in memory
+     * at one time.
      */
     public int getMemoryPageLimit()
     {
@@ -875,7 +879,8 @@ public class LargeSelect<T> implements R
      *
      * @return the number of records that are included on the current page of
      * results.
-     * @throws TorqueException if invoking the <code>populateObjects()<code>
+     *
+     * @throws TorqueException if invoking the <code>populateObjects()</code>
      * method runs into problems or a sleep is unexpectedly interrupted.
      */
     public int getCurrentPageSize() throws TorqueException
@@ -905,7 +910,8 @@ public class LargeSelect<T> implements R
      * Provide the record number of the last row included on the current page.
      *
      * @return the record number of the last row of the current page.
-     * @throws TorqueException if invoking the <code>populateObjects()<code>
+     *
+     * @throws TorqueException if invoking the <code>populateObjects()</code>
      * method runs into problems or a sleep is unexpectedly interrupted.
      */
     public int getLastRecordNoForPage() throws TorqueException
@@ -924,7 +930,8 @@ public class LargeSelect<T> implements R
      *
      * @return progress text in the form of "26 - 50 of &gt; 250" where "&gt;"
      * can be configured using <code>setMoreIndicator()</code>.
-     * @throws TorqueException if invoking the <code>populateObjects()<code>
+     *
+     * @throws TorqueException if invoking the <code>populateObjects()</code>
      * method runs into problems or a sleep is unexpectedly interrupted.
      */
     public String getRecordProgressText() throws TorqueException
@@ -982,7 +989,7 @@ public class LargeSelect<T> implements R
     }
 
     /**
-     * Clear the query result so that the query is reexecuted when the next page
+     * Clear the query result so that the query is re-executed when the next page
      * is retrieved.  You may want to invoke this method if you are returning to
      * a page after performing an operation on an item in the result set.
      *
@@ -1009,7 +1016,7 @@ public class LargeSelect<T> implements R
     /**
      * Retrieve a search parameter.  This acts as a convenient place to store
      * parameters that relate to the LargeSelect to make it easy to get at them
-     * in order to repopulate search parameters on a form when the next page of
+     * in order to re-populate search parameters on a form when the next page of
      * results is retrieved - they in no way effect the operation of
      * LargeSelect.
      *
@@ -1024,7 +1031,7 @@ public class LargeSelect<T> implements R
     /**
      * Retrieve a search parameter.  This acts as a convenient place to store
      * parameters that relate to the LargeSelect to make it easy to get at them
-     * in order to repopulate search parameters on a form when the next page of
+     * in order to re-populate search parameters on a form when the next page of
      * results is retrieved - they in no way effect the operation of
      * LargeSelect.
      *
@@ -1082,11 +1089,11 @@ public class LargeSelect<T> implements R
     }
 
     /**
-     * Deserialize this LargeSelect instance.
+     * De-serialize this LargeSelect instance.
      *
      * @param inputStream The serialization input stream.
-     * @throws IOException
-     * @throws ClassNotFoundException
+     * @throws IOException if input stream cannot be read
+     * @throws ClassNotFoundException if class not found
      */
     private void readObject(final ObjectInputStream inputStream)
             throws IOException, ClassNotFoundException

Modified: db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/ResultsetSpliterator.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/ResultsetSpliterator.java?rev=1850965&r1=1850964&r2=1850965&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/ResultsetSpliterator.java (original)
+++ db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/ResultsetSpliterator.java Thu Jan 10 17:21:29 2019
@@ -52,12 +52,11 @@ public class ResultsetSpliterator<T> ext
     /**
      * Constructor
      *
-     * @param recordMapper a RecordMapper to map ResultSet rows to entities of type
-     *                     <T>
+     * @param recordMapper a RecordMapper to map ResultSet rows to entities of type T
      * @param criteria     a Criteria
      * @param statement    the statement that created the ResultSet
      * @param resultSet    the JDBC result set
-     * @throws TorqueException
+     * @throws TorqueException backend database exception
      */
     public ResultsetSpliterator(RecordMapper<T> recordMapper, Criteria criteria,
             Statement statement, ResultSet resultSet) throws TorqueException
@@ -95,10 +94,10 @@ public class ResultsetSpliterator<T> ext
         }
     }
 
-    /**
-     * Advance ResultSet and map row to entity <T>
-     *
+    /* (non-Javadoc)
      * @see java.util.Spliterator#tryAdvance(java.util.function.Consumer)
+     *
+     * Advance ResultSet and map row to entity &lt;T&gt;
      */
     @Override
     public boolean tryAdvance(Consumer<? super T> action)

Modified: db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/SummaryHelper.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/SummaryHelper.java?rev=1850965&r1=1850964&r2=1850965&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/SummaryHelper.java (original)
+++ db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/SummaryHelper.java Thu Jan 10 17:21:29 2019
@@ -40,11 +40,13 @@ import org.apache.torque.om.mapper.Objec
 import org.apache.torque.util.functions.SQLFunction;
 
 /**
- * <p>A utility to help produce aggregate summary information about a table.
+ * <p>
+ * A utility to help produce aggregate summary information about a table.
  * The default assumes that the underlying DB supports the SQL 99 Standard
- * Aggregate functions, e.g. COUNT, SUM, AVG, MAX, & MIN.  However, some
- * non-standard functions (like MySQL's older LEAST instead of MIN can be
- * handled programatically if needed (@see Aggregate class)</p>
+ * Aggregate functions, e.g. COUNT, SUM, AVG, MAX, &amp; MIN.  However, some
+ * non-standard functions (like MySQL's older LEAST instead of MIN) can be
+ * handled programmatically if needed {@link org.apache.torque.util.functions.AggregateFunction}
+ * </p>
  *
  * <P>Here is a simple example to generate the results of a query like:</P>
  *
@@ -108,7 +110,7 @@ public class SummaryHelper
      *
      * @param crit The base criteria to build on.
      *
-     * @return Results as a OrderMap<String, List<Object>> object.
+     * @return Results as a OrderMap&lt;String, List&lt;Object&gt;&gt; object.
      *
      * @throws TorqueException if a database error occurs.
      */
@@ -130,7 +132,7 @@ public class SummaryHelper
      *        See org.apache.torque.om.mapper.ObjectListMapper�for the supported
      *        classes.
      *
-     * @return Results as a ListOrderMapCI<String, List<Object>> object.
+     * @return Results as a ListOrderMapCI&lt;String, List&lt;Object&gt;&gt; object.
      *
      * @throws TorqueException if a database error occurs.
      */
@@ -157,7 +159,7 @@ public class SummaryHelper
      * @param crit The base criteria to build on.
      * @param conn The DB Connection to use.
      *
-     * @return Results as a OrderMap<String, List<Object>> object.
+     * @return Results as a OrderMap&lt;String, List&lt;Object&gt;&gt; object.
      *
      * @throws TorqueException if a database error occurs.
      */
@@ -181,7 +183,7 @@ public class SummaryHelper
      *        classes.
      * @param conn The DB Connection to use.
      *
-     * @return Results as a ListOrderedMapCI<String,Values> object.
+     * @return Results as a ListOrderedMapCI&lt;String,Values&gt; object.
      *
      * @throws TorqueException if a database error occurs.
      */
@@ -243,7 +245,7 @@ public class SummaryHelper
      *
      * @param c The base criteria to build the summary criteria from.
      * @return A criteria to use in summarizing the information.
-     * @throws TorqueException
+     * @throws TorqueException if a database error occurs.
      */
     public Criteria buildCriteria(final Criteria c) throws TorqueException
     {
@@ -326,7 +328,7 @@ public class SummaryHelper
      *
      * <p>Generates SQL like:  SELECT .... GROUP BY Table.COL1, TABLE.COL2</p>
      *
-     * @param column
+     * @param column to group by
      */
     public void addGroupBy(final Column column)
     {
@@ -386,10 +388,10 @@ public class SummaryHelper
      * in a semi-CSV format. E.g., there is no handling of embedded
      * quotes/special characters.
      *
-     * @param out
-     * @param results
-     * @param includeHeader
-     * @throws IOException
+     * @param out the output writer
+     * @param results results to store
+     * @param includeHeader boolean flag to include header
+     * @throws IOException if file not found
      */
     public void dumpResults(final Writer out, final List<?> results, final boolean includeHeader)
             throws IOException

Modified: db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/TorqueConnectionImpl.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/TorqueConnectionImpl.java?rev=1850965&r1=1850964&r2=1850965&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/TorqueConnectionImpl.java (original)
+++ db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/util/TorqueConnectionImpl.java Thu Jan 10 17:21:29 2019
@@ -58,7 +58,7 @@ public class TorqueConnectionImpl implem
 
     /**
      * Constructor
-     *
+     * @param con Connection object
      */
     public TorqueConnectionImpl(Connection con)
     {



---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]