db-torque-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From tfisc...@apache.org
Subject svn commit: r1336203 - /db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/criteria/FromElement.java
Date Wed, 09 May 2012 13:41:08 GMT
Author: tfischer
Date: Wed May  9 13:41:08 2012
New Revision: 1336203

URL: http://svn.apache.org/viewvc?rev=1336203&view=rev
Log:
improve javadoc
use final for unmodified fields

Modified:
    db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/criteria/FromElement.java

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=1336203&r1=1336202&r2=1336203&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
Wed May  9 13:41:08 2012
@@ -29,7 +29,7 @@ import org.apache.commons.lang.builder.H
  * This class describes an Element in the From-part of a SQL clause.
  * It must contain the name of the database table.
  * It might contain an alias for the table name, a join type
- * and a join condition.
+ * a join condition and prepared statement replacements.
  * The class is immutable.
  */
 public class FromElement
@@ -47,11 +47,12 @@ public class FromElement
     private String joinCondition = null;
 
     /** The replacements which might occur in the fromExpression. */
-    private List<Object> preparedStatementReplacements
+    private final List<Object> preparedStatementReplacements
             = new ArrayList<Object>();
 
     /**
      * 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 />
@@ -63,7 +64,8 @@ public class FromElement
     }
 
     /**
-     * Constructor
+     * Constructor.
+     *
      * @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 />
@@ -86,7 +88,8 @@ public class FromElement
     }
 
     /**
-     * Constructor
+     * Constructor.
+     *
      * @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 />
@@ -120,6 +123,8 @@ public class FromElement
 
 
     /**
+     * Returns the join condition.
+     *
      * @return the join condition, e.g. table_a.id = table_b.a_id,
      *         or null if the join is not an explicit join
      */
@@ -129,6 +134,8 @@ public class FromElement
     }
 
     /**
+     * Returns the join type.
+     *
      * @return the type of the join, e.g. JoinType.LEFT_JOIN,
      *         or null if the join is not an explicit join
      */
@@ -140,6 +147,7 @@ public class FromElement
     /**
      * 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 />
@@ -164,9 +172,11 @@ public class FromElement
     }
 
     /**
-     * Returns a SQL representation of the element
+     * Returns a SQL representation of the element.
+     *
      * @return a SQL representation of the element
      */
+    @Override
     public String toString()
     {
         StringBuffer result = new StringBuffer();



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


Mime
View raw message