cvs commit: jakarta-turbine-torque/src/java/org/apache/torque/om Persistent.java

[mp...@apache.org]

mpoeschl    2002/12/29 10:17:27

  Modified:    src/java/org/apache/torque/om Persistent.java
  Log:
  javadocs
  
  Revision  Changes    Path
  1.11      +11 -3     jakarta-turbine-torque/src/java/org/apache/torque/om/Persistent.java
  
  Index: Persistent.java
  ===================================================================
  RCS file: /home/cvs/jakarta-turbine-torque/src/java/org/apache/torque/om/Persistent.java,v
  retrieving revision 1.10
  retrieving revision 1.11
  diff -u -r1.10 -r1.11
  --- Persistent.java	21 May 2002 19:51:45 -0000	1.10
  +++ Persistent.java	29 Dec 2002 18:17:26 -0000	1.11
  @@ -76,7 +76,7 @@
        * Sets the PrimaryKey for the object.
        *
        * @param primaryKey The new PrimaryKey for the object.
  -     * @exception Exception, This method might throw an exceptions
  +     * @throws Exception This method might throw an exception
        */
       void setPrimaryKey(ObjectKey primaryKey) throws Exception;
   
  @@ -85,7 +85,7 @@
        *
        * @param primaryKey the String should be of the form produced by
        *        ObjectKey.toString().
  -     * @exception Exception, This method might throw an exceptions
  +     * @throws Exception This method might throw an exception
        */
       void setPrimaryKey(String primaryKey) throws Exception;
   
  @@ -123,12 +123,17 @@
   
       /**
        * Saves the object.
  +     *
  +     * @throws Exception This method might throw an exception
        */
       void save() throws Exception;
   
       /**
        * Stores the object in the database.  If the object is new,
        * it inserts it; otherwise an update is performed.
  +     *
  +     * @param dbName the name of the database
  +     * @throws Exception This method might throw an exception
        */
       void save(String dbName) throws Exception;
   
  @@ -138,6 +143,9 @@
        * is meant to be used as part of a transaction, otherwise use
        * the save() method and the connection details will be handled
        * internally
  +     *
  +     * @param con the Connection used to store the object
  +     * @throws Exception This method might throw an exception
        */
       void save(Connection con) throws Exception;
   }