db-torque-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From pain...@apache.org
Subject svn commit: r1850502 - in /db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates: bean/base/ dbObject/base/ dbObject/base/bean/
Date Sat, 05 Jan 2019 16:47:35 GMT
Author: painter
Date: Sat Jan  5 16:47:35 2019
New Revision: 1850502

URL: http://svn.apache.org/viewvc?rev=1850502&view=rev
Log:
Improve JavaDoc compliance for generated objects

Modified:
    db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/bean/base/baseBean.vm
    db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/adderReferencingObject.vm
    db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/bean/objectBeanMethods.vm
    db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/copyMethods.vm
    db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/getterReferencedObject.vm
    db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/getterReferencingObject.vm
    db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/isCacheOnSave.vm
    db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/isInitializedReferencingObject.vm
    db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/joinGetterReferencingObject.vm
    db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/primaryKeyMethods.vm
    db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/setterReferencedObjectByObjectKey.vm
    db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/tableMapGetter.vm

Modified: db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/bean/base/baseBean.vm
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/bean/base/baseBean.vm?rev=1850502&r1=1850501&r2=1850502&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/bean/base/baseBean.vm
(original)
+++ db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/bean/base/baseBean.vm
Sat Jan  5 16:47:35 2019
@@ -98,6 +98,8 @@ $torqueGen.mergepoint("fieldDefinitionsR
 
     /**
      * sets whether the bean exists in the database
+     *
+     * @param isNew if this is a new object
      */
     public void setNew(boolean isNew)
     {
@@ -106,6 +108,8 @@ $torqueGen.mergepoint("fieldDefinitionsR
 
     /**
      * returns whether the bean exists in the database
+     *
+     * @return boolean true if the object is new
      */
     public boolean isNew()
     {
@@ -115,6 +119,8 @@ $torqueGen.mergepoint("fieldDefinitionsR
     /**
      * sets whether the bean or the object it was created from
      * was modified since the object was last read from the database
+     *
+     * @param isModified if the object has been modified since last read
      */
     public void setModified(boolean isModified)
     {
@@ -124,6 +130,8 @@ $torqueGen.mergepoint("fieldDefinitionsR
     /**
      * returns whether the bean or the object it was created from
      * was modified since the object was last read from the database
+     *
+     * @return boolean true if the object is modified
      */
     public boolean isModified()
     {

Modified: db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/adderReferencingObject.vm
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/adderReferencingObject.vm?rev=1850502&r1=1850501&r2=1850502&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/adderReferencingObject.vm
(original)
+++ db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/adderReferencingObject.vm
Sat Jan  5 16:47:35 2019
@@ -62,7 +62,7 @@
      * through the $field foreign key attribute using connection.
      *
      * @param l $fieldContainedType
-     * @throws TorqueException
+     * @throws TorqueException if retrieval of the associated objects fails.
      */
     public void ${adder}($fieldContainedType l, Connection con) throws TorqueException
     {

Modified: db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/bean/objectBeanMethods.vm
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/bean/objectBeanMethods.vm?rev=1850502&r1=1850501&r2=1850502&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/bean/objectBeanMethods.vm
(original)
+++ db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/bean/objectBeanMethods.vm
Sat Jan  5 16:47:35 2019
@@ -123,6 +123,7 @@
      * @param bean the $beanClassName which contents are used to create
      *        the resulting class
      * @return an instance of $javaName with the contents of bean
+     * @throws TorqueException if unable to create the bean
      */
     public static $javaName create${javaName}(${beanClassName} bean)
         throws TorqueException
@@ -142,6 +143,7 @@
      * @param createdObjects a IdentityMap which maps beans
      *        to already created objects
      * @return an instance of ${javaName} with the contents of bean
+     * @throws TorqueException if unable to create the bean
      */
     public static ${javaName} create${javaName}(${beanClassName} bean, IdentityMap createdObjects)
         throws TorqueException

Modified: db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/copyMethods.vm
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/copyMethods.vm?rev=1850502&r1=1850501&r2=1850502&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/copyMethods.vm
(original)
+++ db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/copyMethods.vm
Sat Jan  5 16:47:35 2019
@@ -30,6 +30,7 @@
      * It then fills all the association collections and sets the
      * related objects to isNew=true.
   #end
+	 * @throws TorqueException if retrieval of the associated objects fails  
      */
     public $dbObjectClassName copy() throws TorqueException
     {
@@ -49,6 +50,7 @@ $torqueGen.mergepoint("createObjectInsta
      * related objects to isNew=true.
      *
      * @param con the database connection to read associated objects.
+	 * @throws TorqueException if retrieval of the associated objects fails     
      */
     public $dbObjectClassName copy(Connection con) throws TorqueException
     {
@@ -63,6 +65,7 @@ $torqueGen.mergepoint("createObjectInsta
      * isNew=true.
      *
      * @param deepcopy whether to copy the associated objects.
+     * @throws TorqueException if retrieval of the associated objects fails
      */
     public $dbObjectClassName copy(boolean deepcopy) throws TorqueException
     {
@@ -79,6 +82,7 @@ $torqueGen.mergepoint("createObjectInsta
      *
      * @param deepcopy whether to copy the associated objects.
      * @param con the database connection to read associated objects.
+     * @throws TorqueException if retrieval of the associated objects fails
      */
     public $dbObjectClassName copy(boolean deepcopy, Connection con) throws TorqueException
     {
@@ -93,6 +97,7 @@ $torqueGen.mergepoint("createObjectInsta
      * The associated objects are also copied and treated as new objects.
      *
      * @param copyObj the object to fill.
+     * @throws TorqueException if retrieval of the associated objects fails
      */
     public $dbObjectClassName copyInto($dbObjectClassName copyObj) throws TorqueException
     {
@@ -105,6 +110,7 @@ $torqueGen.mergepoint("createObjectInsta
      *
      * @param copyObj the object to fill.
      * @param con the database connection to read associated objects.
+     * @throws TorqueException if retrieval of the associated objects fails
      */
     public $dbObjectClassName copyInto($dbObjectClassName copyObj, Connection con) throws
TorqueException
     {
@@ -123,6 +129,7 @@ $torqueGen.mergepoint("createObjectInsta
 #if ($torqueGen.booleanOption("torque.om.complexObjectModel") && $torqueGen.booleanOption("torque.om.objectIsCaching"))
      * @param deepcopy whether the associated objects should be copied.
 #end
+     * @throws TorqueException if retrieval of the associated objects fails
      */
 #if ($torqueGen.booleanOption("torque.om.complexObjectModel") && $torqueGen.booleanOption("torque.om.objectIsCaching"))
     protected $dbObjectClassName copyInto($dbObjectClassName copyObj, boolean deepcopy) throws
TorqueException
@@ -197,6 +204,7 @@ $torqueGen.mergepoint("createObjectInsta
      * @param copyObj the object to fill.
      * @param deepcopy whether the associated objects should be copied.
      * @param con the database connection to read associated objects.
+     * @throws TorqueException if retrieval of the associated objects fails
      */
     public $dbObjectClassName copyInto($dbObjectClassName copyObj, boolean deepcopy, Connection
con) throws TorqueException
     {

Modified: db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/getterReferencedObject.vm
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/getterReferencedObject.vm?rev=1850502&r1=1850501&r2=1850502&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/getterReferencedObject.vm
(original)
+++ db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/getterReferencedObject.vm
Sat Jan  5 16:47:35 2019
@@ -122,7 +122,7 @@
      * @param connection the connection used to retrieve the associated object
      *        from the database, if it was not retrieved before
      * @return the associated $fieldType object
-     * @throws TorqueException
+     * @throws TorqueException If a problem occurs with the get[$filedType] method.
      */
     public $fieldType ${getter}(Connection connection)
         throws TorqueException

Modified: db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/getterReferencingObject.vm
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/getterReferencingObject.vm?rev=1850502&r1=1850501&r2=1850502&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/getterReferencingObject.vm
(original)
+++ db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/getterReferencingObject.vm
Sat Jan  5 16:47:35 2019
@@ -96,7 +96,7 @@ $torqueGen.mergepoint("backreference")##
      * an empty collection or the current collection, the criteria
      * is ignored on a new object.
      *
-     * @throws TorqueException
+     * @throws TorqueException If a problem occurs with the get[criteria] method.     
      */
     public $fieldType ${getter}(Criteria criteria) throws TorqueException
     {
@@ -165,6 +165,10 @@ $torqueGen.mergepoint("backreference")##
      * This method takes in the Connection also as input so that
      * referenced objects can also be obtained using a Connection
      * that is taken as input
+     *
+     * @param con the Connection
+     * @return $fieldType results of the collection
+     * @throws TorqueException If a problem occurs with the get[connection] method.
      */
     public $fieldType ${getter}(Connection con) throws TorqueException
     {
@@ -197,6 +201,10 @@ $torqueGen.mergepoint("backreference")##
      * This method takes in the Connection also as input so that
      * referenced objects can also be obtained using a Connection
      * that is taken as input
+     *
+     * @param con the Connection
+     * @return $fieldType results of the collection
+     * @throws TorqueException If a problem occurs with the get[connection] method.
      */
     public $fieldType ${getter}(Criteria criteria, Connection con)
             throws TorqueException

Modified: db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/isCacheOnSave.vm
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/isCacheOnSave.vm?rev=1850502&r1=1850501&r2=1850502&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/isCacheOnSave.vm
(original)
+++ db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/isCacheOnSave.vm
Sat Jan  5 16:47:35 2019
@@ -24,6 +24,8 @@
     /**
      * Specify whether to cache the object after saving to the db.
      * This method returns true
+     *
+     * @return boolean true if set to cache on save
      */
     protected boolean isCacheOnSave()
     {

Modified: db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/isInitializedReferencingObject.vm
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/isInitializedReferencingObject.vm?rev=1850502&r1=1850501&r2=1850502&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/isInitializedReferencingObject.vm
(original)
+++ db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/isInitializedReferencingObject.vm
Sat Jan  5 16:47:35 2019
@@ -29,6 +29,8 @@
     /**
      * Checks whether the cache $field for referenced objects has either been
      * loaded from the database or has been manually initialized.
+     *
+     * @return boolean true if initialized
      */
     public boolean ${isInitialized}()
     {

Modified: db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/joinGetterReferencingObject.vm
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/joinGetterReferencingObject.vm?rev=1850502&r1=1850501&r2=1850502&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/joinGetterReferencingObject.vm
(original)
+++ db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/joinGetterReferencingObject.vm
Sat Jan  5 16:47:35 2019
@@ -54,7 +54,9 @@
      * api reasonable.  You can change the access modifier to public
      * by overriding this method in the child class.
      *
+     * @return $fieldType the collection
      * @param criteria the criteria to use when filling the collection.
+     * @throws TorqueException if associated objects are not found
      */
     ${getterAccessModifier} $fieldType ${getter}(Criteria criteria) throws TorqueException
     {

Modified: db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/primaryKeyMethods.vm
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/primaryKeyMethods.vm?rev=1850502&r1=1850501&r2=1850502&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/primaryKeyMethods.vm
(original)
+++ db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/primaryKeyMethods.vm
Sat Jan  5 16:47:35 2019
@@ -87,7 +87,7 @@
     /**
      * Set the PrimaryKey using a String.
      *
-     * @param key
+     * @param key the primary key to set.
      */
     public void setPrimaryKey(String key) $throwsClause
     {
@@ -192,6 +192,7 @@
 
     /**
      * Set the PrimaryKey using a String.
+     * @param key the primary key to set.
      */
     public void setPrimaryKey(String key) throws TorqueException
     {
@@ -216,7 +217,6 @@
      * Set the PrimaryKey using a String.
      *
      * @param key the primary key to set.
-     *
      * @throws NoSuchOperationException always.
      */
     public void setPrimaryKey(String key) throws TorqueException

Modified: db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/setterReferencedObjectByObjectKey.vm
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/setterReferencedObjectByObjectKey.vm?rev=1850502&r1=1850501&r2=1850502&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/setterReferencedObjectByObjectKey.vm
(original)
+++ db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/setterReferencedObjectByObjectKey.vm
Sat Jan  5 16:47:35 2019
@@ -40,6 +40,8 @@
      * If for some reason this is impossible, this method should be
      * overridden in <code>$localTableElement.getAttribute("javaName")</code>.
 #end
+     * @param key the key to set
+     * @throws TorqueException if associated objects are not found
      */
     public void ${setter}Key(ObjectKey<?> key) throws TorqueException
     {

Modified: db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/tableMapGetter.vm
URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/tableMapGetter.vm?rev=1850502&r1=1850501&r2=1850502&view=diff
==============================================================================
--- db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/tableMapGetter.vm
(original)
+++ db/torque/torque4/trunk/torque-templates/src/main/resources/org/apache/torque/templates/om/templates/dbObject/base/tableMapGetter.vm
Sat Jan  5 16:47:35 2019
@@ -28,6 +28,7 @@
      * compiler warnings of using getPeer().getTableMap().
      *
      * @return The associated TableMap object.
+     * @throws TorqueException if associated objects are not found
      */
     public TableMap getTableMap() throws TorqueException
     {



---------------------------------------------------------------------
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