You are viewing a plain text version of this content. The canonical link for it is here.
Posted to torque-dev@db.apache.org by tf...@apache.org on 2012/07/12 03:31:37 UTC
svn commit: r1360500 - in
/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque:
Torque.java criteria/Criteria.java criteria/Join.java map/DatabaseMap.java
map/ForeignKeyMap.java map/TableMap.java
Author: tfischer
Date: Thu Jul 12 01:31:37 2012
New Revision: 1360500
URL: http://svn.apache.org/viewvc?rev=1360500&view=rev
Log:
- javadoc/param name fixes
- @Override and @Deprecated annotations
Modified:
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/criteria/Criteria.java
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/criteria/Join.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/ForeignKeyMap.java
db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/map/TableMap.java
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=1360500&r1=1360499&r2=1360500&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 Jul 12 01:31:37 2012
@@ -412,7 +412,7 @@ public final class Torque
/**
* Returns the database for the given key.
*
- * @param databaseName the key to get the database for,
+ * @param name the key to get the database for,
* or null for the default database.
*
* @return the Database for the given name, or null if no database exists
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=1360500&r1=1360499&r2=1360500&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 Jul 12 01:31:37 2012
@@ -359,6 +359,7 @@ public class Criteria
* @deprecated use the constructor Criterion(Column, Object, SqlEnum)
* instead.
*/
+ @Deprecated
public Criterion getNewCriterion(Column column, Object value,
SqlEnum comparison)
{
@@ -877,6 +878,7 @@ public class Criteria
*
* @return A String with the representation of the Criteria.
*/
+ @Override
public String toString()
{
StringBuilder sb = new StringBuilder("Criteria: ");
@@ -944,6 +946,7 @@ public class Criteria
*
* @return a hash code value for this object.
*/
+ @Override
public int hashCode()
{
HashCodeBuilder hashCodeBuilder = new HashCodeBuilder();
@@ -967,6 +970,7 @@ public class Criteria
/**
* Returns a cloned object.
*/
+ @Override
public Object clone()
{
try
@@ -1007,6 +1011,7 @@ public class Criteria
* This method will be removed in a future version of Torque.
* Use and(...) or where(...) instead.
*/
+ @Deprecated
public Criteria add(Criterion c)
{
if (topLevelCriterion == null)
@@ -1043,6 +1048,7 @@ public class Criteria
* This method will be removed in a future version of Torque.
* Use and(...) or where(...) instead.
*/
+ @Deprecated
public Criteria add(Object lValue, Object rValue)
{
add(lValue, rValue, EQUAL);
@@ -1073,6 +1079,7 @@ public class Criteria
* This method will be removed in a future version of Torque.
* Use and(...) or where(...) instead.
*/
+ @Deprecated
public Criteria add(Object lValue, Object rValue, SqlEnum comparison)
{
Criterion newCriterion;
@@ -1123,6 +1130,7 @@ public class Criteria
* This method will be removed in a future version of Torque.
* Use and(...) or where(...) instead.
*/
+ @Deprecated
public Criteria addDate(Object lValue, int year, int month, int day)
{
add(lValue,
@@ -1157,6 +1165,7 @@ public class Criteria
* This method will be removed in a future version of Torque.
* Use and(...) or where(...) instead.
*/
+ @Deprecated
public Criteria addDate(Object lValue, int year, int month, int day,
SqlEnum comparison)
{
@@ -1188,6 +1197,7 @@ public class Criteria
* This method will be removed in a future version of Torque.
* Use and(...) or where(...) instead.
*/
+ @Deprecated
public Criteria addIn(Object lValue, Object[] rValues)
{
add(lValue, rValues, Criteria.IN);
@@ -1220,6 +1230,7 @@ public class Criteria
* This method will be removed in a future version of Torque.
* Use and(...) or where(...) instead.
*/
+ @Deprecated
public Criteria addIn(Object lValue, Collection<?> rValues)
{
add(lValue, rValues, Criteria.IN);
@@ -1250,6 +1261,7 @@ public class Criteria
* This method will be removed in a future version of Torque.
* Use and(...) or where(...) instead.
*/
+ @Deprecated
public Criteria addNotIn(Object lValue, Object[] rValues)
{
add(lValue, rValues, Criteria.NOT_IN);
@@ -1282,6 +1294,7 @@ public class Criteria
* This method will be removed in a future version of Torque.
* Use and(...) or where(...) instead.
*/
+ @Deprecated
public Criteria addNotIn(Object lValue, Collection<?> rValues)
{
add(lValue, rValues, Criteria.NOT_IN);
@@ -1444,11 +1457,11 @@ public class Criteria
*
* @return A modified Criteria object.
*/
- public Criteria andDate(Object lValue, int year, int month, int date,
+ public Criteria andDate(Object lValue, int year, int month, int day,
SqlEnum comparison)
{
return and(lValue,
- new GregorianCalendar(year, month, date).getTime(),
+ new GregorianCalendar(year, month, day).getTime(),
comparison);
}
@@ -1757,11 +1770,11 @@ public class Criteria
*
* @return A modified Criteria object.
*/
- public Criteria orDate(Object lValue, int year, int month, int date,
+ public Criteria orDate(Object lValue, int year, int month, int day,
SqlEnum comparison)
{
return or(lValue,
- new GregorianCalendar(year, month, date).getTime(),
+ new GregorianCalendar(year, month, day).getTime(),
comparison);
}
@@ -2070,7 +2083,7 @@ public class Criteria
* If this object is c Criteria, it is interpreted as a subselect.
* In all other cases, (e.G. string object), it is interpreted as
* literal value.
- * @param lValues The values to compare against.
+ * @param rValues The values to compare against.
*
* @return A modified Criteria object.
*/
Modified: db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/criteria/Join.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/criteria/Join.java?rev=1360500&r1=1360499&r2=1360500&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/criteria/Join.java (original)
+++ db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/criteria/Join.java Thu Jul 12 01:31:37 2012
@@ -106,7 +106,7 @@ public class Join implements Serializabl
* or null to be determined from the join clause.
* @param rightTable the right table of the join, might contain an alias
* name, or null to be determined from the join clause.
- * @param joinType the join condition, not null.
+ * @param joinCondition the join condition, not null.
* @param joinType the type of the join, or null
* (adding the join condition to the where clause).
*/
@@ -166,6 +166,7 @@ public class Join implements Serializabl
*
* @return a String representation of the class
*/
+ @Override
public String toString()
{
@@ -177,6 +178,7 @@ public class Join implements Serializabl
* This method checks another Criteria.Join to see if they contain the
* same attributes.
*/
+ @Override
public boolean equals(Object obj)
{
if (this == obj)
@@ -203,6 +205,7 @@ public class Join implements Serializabl
*
* @return a hash code value for this object.
*/
+ @Override
public int hashCode()
{
return new HashCodeBuilder()
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=1360500&r1=1360499&r2=1360500&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 Jul 12 01:31:37 2012
@@ -229,7 +229,7 @@ public class DatabaseMap
/**
* Add a new TableMap to the database.
*
- * @param map The TableMap representation.
+ * @param idTableMap The TableMap representation.
*/
public void setIdTable(TableMap idTableMap)
{
@@ -371,9 +371,8 @@ public class DatabaseMap
* JavaNameGenerator class in Generator code.
*
* @param schemaName name to be converted.
- * @return converted name.
*
- * @see org.apache.torque.engine.database.model.NameGenerator
+ * @return converted name.
*/
protected String javanameMethod(String schemaName)
{
Modified: db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/map/ForeignKeyMap.java
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/map/ForeignKeyMap.java?rev=1360500&r1=1360499&r2=1360500&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/map/ForeignKeyMap.java (original)
+++ db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/map/ForeignKeyMap.java Thu Jul 12 01:31:37 2012
@@ -229,7 +229,7 @@ public class ForeignKeyMap
*
* @param foreignKeyMap the foreign key map this columnPait belongs to.
* @param local the local column, not null.
- * @param foreign the foreign column, not null.
+ * @param foreignName the foreign column, not null.
*
* @throws NullPointerException if local or doreign are null.
*/
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=1360500&r1=1360499&r2=1360500&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 Jul 12 01:31:37 2012
@@ -374,9 +374,9 @@ public class TableMap
*
* @param foreignKey the foreign key map, not null
*/
- public void addForeignKey(ForeignKeyMap fk)
+ public void addForeignKey(ForeignKeyMap foreignKey)
{
- foreignKeys.add(fk);
+ foreignKeys.add(foreignKey);
}
/**
---------------------------------------------------------------------
To unsubscribe, e-mail: torque-dev-unsubscribe@db.apache.org
For additional commands, e-mail: torque-dev-help@db.apache.org