You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@turbine.apache.org by mp...@apache.org on 2002/03/14 01:59:29 UTC
cvs commit: jakarta-turbine-torque/src/java/org/apache/torque TorqueRuntimeException.java
mpoeschl 02/03/13 16:59:29
Modified: src/java/org/apache/torque/engine/database/model Table.java
src/java/org/apache/torque/map TableMap.java
src/java/org/apache/torque/util BasePeer.java Criteria.java
src/java/org/apache/torque TorqueRuntimeException.java
Log:
fix javadoc warnings displayed by jdk1.4
Revision Changes Path
1.26 +10 -10 jakarta-turbine-torque/src/java/org/apache/torque/engine/database/model/Table.java
Index: Table.java
===================================================================
RCS file: /home/cvs/jakarta-turbine-torque/src/java/org/apache/torque/engine/database/model/Table.java,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -r1.25 -r1.26
--- Table.java 13 Mar 2002 21:31:23 -0000 1.25
+++ Table.java 14 Mar 2002 00:59:29 -0000 1.26
@@ -75,7 +75,7 @@
* @author <a href="mailto:jmcnally@collab.net>John McNally</a>
* @author <a href="mailto:dlr@collab.net>Daniel Rall</a>
* @author <a href="mailto:byron_foster@byron_foster@yahoo.com>Byron Foster</a>
- * @version $Id: Table.java,v 1.25 2002/03/13 21:31:23 jmcnally Exp $
+ * @version $Id: Table.java,v 1.26 2002/03/14 00:59:29 mpoeschl Exp $
*/
public class Table implements IDMethod
{
@@ -713,30 +713,30 @@
this.alias = v;
}
-
+
/**
* Interface which objects for this table will implement
* @return value of interface.
*/
- public String getInterface()
+ public String getInterface()
{
return enterface;
}
-
+
/**
* Interface which objects for this table will implement
* @param v Value to assign to interface.
*/
- public void setInterface(String v)
+ public void setInterface(String v)
{
this.enterface = v;
}
-
+
/**
* When a table is abstract, it marks the business object class that is
- * generated as being abstract. if you have a table called "FOO", then the
- * Foo BO will be public abstract class Foo
+ * generated as being abstract. If you have a table called "FOO", then the
+ * Foo BO will be <code>public abstract class Foo</code>
* This helps support class hierarchies
*
* @return value of abstractValue.
@@ -748,9 +748,9 @@
/**
* When a table is abstract, it marks the business object
- * class that is generated as being abstract. if you have a
+ * class that is generated as being abstract. If you have a
* table called "FOO", then the Foo BO will be
- * public abstract class Foo
+ * <code>public abstract class Foo</code>
* This helps support class hierarchies
*
* @param v Value to assign to abstractValue.
1.6 +5 -6 jakarta-turbine-torque/src/java/org/apache/torque/map/TableMap.java
Index: TableMap.java
===================================================================
RCS file: /home/cvs/jakarta-turbine-torque/src/java/org/apache/torque/map/TableMap.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- TableMap.java 19 Sep 2001 22:25:31 -0000 1.5
+++ TableMap.java 14 Mar 2002 00:59:29 -0000 1.6
@@ -66,7 +66,7 @@
*
* @author <a href="mailto:jmcnally@collab.net">John D. McNally</a>
* @author <a href="mailto:dlr@finemaltcoding.com">Daniel Rall</a>
- * @version $Id: TableMap.java,v 1.5 2001/09/19 22:25:31 jon Exp $
+ * @version $Id: TableMap.java,v 1.6 2002/03/14 00:59:29 mpoeschl Exp $
*/
public class TableMap implements IDMethod, java.io.Serializable
{
@@ -277,10 +277,9 @@
}
/**
- * Get the information used to generate a primary key using a
- * sequence.
+ * Get the information used to generate a primary key using a sequence.
*
- * @deprecated. Use getPrimaryKeyMethodInfo
+ * @deprecated Use getPrimaryKeyMethodInfo
*/
public Object getSequenceInfo()
{
@@ -525,7 +524,7 @@
/**
* Sets the sequence information needed to generate a key
*
- * @deprecated. Use setPrimaryKeyMethodInfo
+ * @deprecated Use setPrimaryKeyMethodInfo
*/
public void setSequenceInfo(Object pkInfo)
{
@@ -535,7 +534,7 @@
/**
* Sets the pk information needed to generate a key
*
- * @param. pkInfo information needed to generate a key
+ * @param pkInfo information needed to generate a key
*/
public void setPrimaryKeyMethodInfo(Object pkInfo)
{
1.32 +25 -54 jakarta-turbine-torque/src/java/org/apache/torque/util/BasePeer.java
Index: BasePeer.java
===================================================================
RCS file: /home/cvs/jakarta-turbine-torque/src/java/org/apache/torque/util/BasePeer.java,v
retrieving revision 1.31
retrieving revision 1.32
diff -u -r1.31 -r1.32
--- BasePeer.java 12 Mar 2002 12:52:27 -0000 1.31
+++ BasePeer.java 14 Mar 2002 00:59:29 -0000 1.32
@@ -115,7 +115,7 @@
* @author <a href="mailto:frank.kim@clearink.com">Frank Y. Kim</a>
* @author <a href="mailto:jmcnally@collab.net">John D. McNally</a>
* @author <a href="mailto:bmclaugh@algx.net">Brett McLaughlin</a>
- * @version $Id: BasePeer.java,v 1.31 2002/03/12 12:52:27 mpoeschl Exp $
+ * @version $Id: BasePeer.java,v 1.32 2002/03/14 00:59:29 mpoeschl Exp $
*/
public abstract class BasePeer implements java.io.Serializable
{
@@ -1686,26 +1686,20 @@
}
/**
- * Use this method for performing an update of the kind:
- *
- * <p>
- *
- * "WHERE primary_key_id = an int"
- *
- * <p>
- *
* Convenience method used to update rows in the DB. Checks if a
* <i>single</i> int primary key is specified in the Criteria
* object and uses it to perform the udpate. If no primary key is
* specified an Exception will be thrown.
- *
* <p>
- *
+ * Use this method for performing an update of the kind:
+ * <p>
+ * "WHERE primary_key_id = an int"
+ * <p>
* To perform an update with non-primary key fields in the WHERE
* clause use doUpdate(criteria, criteria).
*
* @param updateValues A Criteria object containing values used in
- * set clause.
+ * set clause.
* @exception TorqueException
*/
public static void doUpdate(Criteria updateValues)
@@ -1741,28 +1735,21 @@
}
}
-
/**
- * Use this method for performing an update of the kind:
- *
- * <p>
- *
- * "WHERE primary_key_id = an int"
- *
- * <p>
- *
* Convenience method used to update rows in the DB. Checks if a
* <i>single</i> int primary key is specified in the Criteria
* object and uses it to perform the udpate. If no primary key is
* specified an Exception will be thrown.
- *
* <p>
- *
+ * Use this method for performing an update of the kind:
+ * <p>
+ * "WHERE primary_key_id = an int"
+ * <p>
* To perform an update with non-primary key fields in the WHERE
* clause use doUpdate(criteria, criteria).
*
* @param updateValues A Criteria object containing values used in
- * set clause.
+ * set clause.
* @param dbCon A DBConnection.
* @exception TorqueException
*/
@@ -1789,22 +1776,18 @@
}
/**
+ * Method used to update rows in the DB. Rows are selected based
+ * on selectCriteria and updated using values in updateValues.
+ * <p>
* Use this method for performing an update of the kind:
- *
* <p>
- *
* WHERE some_column = some value AND could_have_another_column =
* another value AND so on...
*
- * <p>
- *
- * Method used to update rows in the DB. Rows are selected based
- * on selectCriteria and updated using values in updateValues.
- *
- * @param selectCriteria A Criteria object containing values used
- * in where clause.
- * @param updateValues A Criteria object containing values used in
- * set clause.
+ * @param selectCriteria A Criteria object containing values used in where
+ * clause.
+ * @param updateValues A Criteria object containing values used in set
+ * clause.
* @exception TorqueException
*/
public static void doUpdate(Criteria selectCriteria,
@@ -1840,24 +1823,19 @@
}
}
-
/**
+ * Method used to update rows in the DB. Rows are selected based
+ * on selectCriteria and updated using values in updateValues.
+ * <p>
* Use this method for performing an update of the kind:
- *
* <p>
- *
* WHERE some_column = some value AND could_have_another_column =
* another value AND so on.
*
- * <p>
- *
- * Method used to update rows in the DB. Rows are selected based
- * on selectCriteria and updated using values in updateValues.
- *
- * @param selectCriteria A Criteria object containing values used
- * in where clause.
- * @param updateValues A Criteria object containing values used in
- * set clause.
+ * @param selectCriteria A Criteria object containing values used in where
+ * clause.
+ * @param updateValues A Criteria object containing values used in set
+ * clause.
* @param dbCon A DBConnection.
* @exception TorqueException
*/
@@ -2009,7 +1987,6 @@
return rowCount;
}
-
/**
* Utility method which executes a given sql statement. This
* method should be used for update, insert, and delete
@@ -2062,7 +2039,6 @@
return rowCount;
}
-
/**
* If the user specified that (s)he only wants to retrieve a
* single record and multiple records are retrieved, this method
@@ -2095,7 +2071,6 @@
* org.apache.torque.util.db.map.TurbineMapBuilder.
*
* @return A MapBuilder.
- *
*/
public static MapBuilder getMapBuilder()
throws TorqueException
@@ -2177,7 +2152,6 @@
return null;
}
-
/**
* Performs a SQL <code>select</code> using a PreparedStatement.
*
@@ -2247,7 +2221,6 @@
return v;
}
-
/**
* Do a Prepared Statement select according to the given criteria
*/
@@ -2268,7 +2241,6 @@
return v;
}
-
/**
* Create a new PreparedStatement. It builds a string representation
* of a query and a list of PreparedStatement parameters.
@@ -2339,7 +2311,6 @@
fromClause.add(tableName);
}
}
-
Iterator it = aliases.keySet().iterator();
while(it.hasNext())
1.18 +21 -21 jakarta-turbine-torque/src/java/org/apache/torque/util/Criteria.java
Index: Criteria.java
===================================================================
RCS file: /home/cvs/jakarta-turbine-torque/src/java/org/apache/torque/util/Criteria.java,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -r1.17 -r1.18
--- Criteria.java 12 Mar 2002 12:52:27 -0000 1.17
+++ Criteria.java 14 Mar 2002 00:59:29 -0000 1.18
@@ -92,7 +92,7 @@
* @author <a href="mailto:bmclaugh@algx.net">Brett McLaughlin</a>
* @author <a href="mailto:eric@dobbse.net">Eric Dobbs</a>
* @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
- * @version $Id: Criteria.java,v 1.17 2002/03/12 12:52:27 mpoeschl Exp $
+ * @version $Id: Criteria.java,v 1.18 2002/03/14 00:59:29 mpoeschl Exp $
*/
public class Criteria extends Hashtable
{
@@ -1253,7 +1253,7 @@
}
/**
- * Convenience method to add a long to Criteria
+ * Convenience method to add a long to Criteria.
* Equal to
*
* <p>
@@ -1299,7 +1299,7 @@
}
/**
- * Convenience method to add a float to Criteria
+ * Convenience method to add a float to Criteria.
* Equal to
*
* <p>
@@ -1345,7 +1345,7 @@
}
/**
- * Convenience method to add a double to Criteria
+ * Convenience method to add a double to Criteria.
* Equal to
*
* <p>
@@ -1396,7 +1396,7 @@
/**
* Convenience method to add a Date object specified by
- * year, month, and date into the Criteria
+ * year, month, and date into the Criteria.
* Equal to
*
* <p>
@@ -1421,7 +1421,7 @@
/**
* Convenience method to add a Date object specified by
- * year, month, and date into the Criteria
+ * year, month, and date into the Criteria.
* Equal to
*
* <p>
@@ -2251,7 +2251,7 @@
}
/**
- * Convenience method to add a long to Criteria
+ * Convenience method to add a long to Criteria.
* Equal to
*
* <p>
@@ -2297,7 +2297,7 @@
}
/**
- * Convenience method to add a float to Criteria
+ * Convenience method to add a float to Criteria.
* Equal to
*
* <p>
@@ -2343,7 +2343,7 @@
}
/**
- * Convenience method to add a double to Criteria
+ * Convenience method to add a double to Criteria.
* Equal to
*
* <p>
@@ -2367,7 +2367,7 @@
/**
* Convenience method to add a Date object specified by
- * year, month, and date into the Criteria
+ * year, month, and date into the Criteria.
* Equal to
*
* <p>
@@ -2392,7 +2392,7 @@
/**
* Convenience method to add a Date object specified by
- * year, month, and date into the Criteria
+ * year, month, and date into the Criteria.
* Equal to
*
* <p>
@@ -2418,8 +2418,8 @@
}
/**
- * Adds an 'IN' clause with the criteria supplied as an Object
- * array. For example:
+ * Adds an 'IN' clause with the criteria supplied as an Object array.
+ * For example:
*
* <p>
* FOO.NAME IN ('FOO', 'BAR', 'ZOW')
@@ -2443,9 +2443,9 @@
}
/**
- * Adds an 'IN' clause with the criteria supplied as an int array.
- * For example:
- *
+ * Adds an 'IN' clause with the criteria supplied as an int array.
+ * For example:
+ *
* <p>
* FOO.ID IN ('2', '3', '7')
* <p>
@@ -2863,7 +2863,7 @@
}
/**
- * Convenience method to add a long to Criteria
+ * Convenience method to add a long to Criteria.
* Equal to
*
* <p>
@@ -2909,7 +2909,7 @@
}
/**
- * Convenience method to add a float to Criteria
+ * Convenience method to add a float to Criteria.
* Equal to
*
* <p>
@@ -2955,7 +2955,7 @@
}
/**
- * Convenience method to add a double to Criteria
+ * Convenience method to add a double to Criteria.
* Equal to
*
* <p>
@@ -2979,7 +2979,7 @@
/**
* Convenience method to add a Date object specified by
- * year, month, and date into the Criteria
+ * year, month, and date into the Criteria.
* Equal to
*
* <p>
@@ -3004,7 +3004,7 @@
/**
* Convenience method to add a Date object specified by
- * year, month, and date into the Criteria
+ * year, month, and date into the Criteria.
* Equal to
*
* <p>
1.5 +2 -2 jakarta-turbine-torque/src/java/org/apache/torque/TorqueRuntimeException.java
Index: TorqueRuntimeException.java
===================================================================
RCS file: /home/cvs/jakarta-turbine-torque/src/java/org/apache/torque/TorqueRuntimeException.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- TorqueRuntimeException.java 13 Mar 2002 10:33:50 -0000 1.4
+++ TorqueRuntimeException.java 14 Mar 2002 00:59:29 -0000 1.5
@@ -66,7 +66,7 @@
* This is a base class of runtime exeptions thrown by Torque.
*
* This class represents a non-checked type exception (see
- * {@see java.lang.RuntimeException}).
+ * {@link java.lang.RuntimeException}).
* It is intended to ease the debugging by carrying on the information about the
* exception which was caught and provoked throwing the current exception.
* Catching and rethrowing may occur multiple times, and provided that all
@@ -77,7 +77,7 @@
* way.
*
* @author <a href="mailto:Rafal.Krzewski@e-point.pl">Rafal Krzewski</a>
- * @version $Id: TorqueRuntimeException.java,v 1.4 2002/03/13 10:33:50 mpoeschl Exp $
+ * @version $Id: TorqueRuntimeException.java,v 1.5 2002/03/14 00:59:29 mpoeschl Exp $
*/
public class TorqueRuntimeException
extends RuntimeException
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>