db-torque-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From tfisc...@apache.org
Subject svn commit: r1336124 - /db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/Torque.java
Date Wed, 09 May 2012 12:15:00 GMT
Author: tfischer
Date: Wed May  9 12:14:59 2012
New Revision: 1336124

URL: http://svn.apache.org/viewvc?rev=1336124&view=rev
Log:
beautify javadoc

Modified:
    db/torque/torque4/trunk/torque-runtime/src/main/java/org/apache/torque/Torque.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=1336124&r1=1336123&r2=1336124&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 Wed
May  9 12:14:59 2012
@@ -44,9 +44,7 @@ import org.apache.torque.oid.IDBroker;
  */
 public final class Torque
 {
-    /**
-     * The prefix for all configuration keys used by Torque.
-     */
+    /** The prefix for all configuration keys used by Torque. */
     public static final String TORQUE_KEY = "torque";
 
     /**
@@ -55,9 +53,7 @@ public final class Torque
      */
     public static final String DATABASE_KEY = "database";
 
-    /**
-     * The key used to configure the name of the default database.
-     */
+    /** The key used to configure the name of the default database. */
     public static final String DEFAULT_KEY = "default";
 
     /** "schema" Key for the configuration */
@@ -70,9 +66,7 @@ public final class Torque
     public static final String DEFAULT_SCHEMA_KEY
             = DEFAULTS_KEY + "." + SCHEMA_KEY;
 
-    /**
-     * A prefix for <code>Manager</code> properties in the configuration.
-     */
+    /** A prefix for <code>Manager</code> properties in the configuration. */
     public static final String MANAGER_PREFIX = "managed_class.";
 
     /**
@@ -81,14 +75,10 @@ public final class Torque
      */
     public static final String MANAGER_SUFFIX = ".manager";
 
-    /**
-     * property to determine whether caching is used.
-     */
+    /** Name of config property to determine whether caching is used. */
     public static final String CACHE_KEY = "manager.useCache";
 
-    /**
-     * The prefix for configuring the transaction manger.
-     */
+    /** The prefix for configuring the transaction manger. */
     public static final String TRANSACTION_MANAGER_KEY = "transactionManager";
 
     /**
@@ -122,7 +112,7 @@ public final class Torque
     /**
      * Sets the single {@link org.apache.torque.TorqueInstance}
      * used by this class. This is used by the Avalon component
-     * to make sure that only one instance of Torque exists
+     * to make sure that only one instance of Torque exists.
      *
      * @param instance Our singleton.
      */
@@ -132,9 +122,10 @@ public final class Torque
     }
 
     /**
-     * Initialization of Torque with a properties file.
+     * Initialization of Torque with a path to a properties file.
      *
      * @param configFile The absolute path to the configuration file.
+     *
      * @throws TorqueException Any exceptions caught during processing will be
      *         rethrown wrapped into a TorqueException.
      */
@@ -145,9 +136,10 @@ public final class Torque
     }
 
     /**
-     * Initialization of Torque with a properties file.
+     * Initialization of Torque with a configuration.
      *
      * @param conf The Torque configuration.
+     *
      * @throws TorqueException Any exceptions caught during processing will be
      *         rethrown wrapped into a TorqueException.
      */
@@ -194,8 +186,9 @@ public final class Torque
     /**
      * This method returns a Manager for the given name.
      *
-     * @param name name of the manager
-     * @return a Manager
+     * @param name name of the manager.
+     *
+     * @return The requested Manager.
      */
     public static AbstractBaseManager getManager(String name)
     {
@@ -206,8 +199,9 @@ public final class Torque
      * This methods returns either the Manager from the configuration file,
      * or the default one provided by the generated code.
      *
-     * @param name name of the manager
-     * @param defaultClassName the class to use if name has not been configured
+     * @param name name of the manager.
+     * @param defaultClassName the class to use if name has not been configured.
+     *
      * @return a Manager
      */
     public static AbstractBaseManager getManager(String name,
@@ -222,7 +216,8 @@ public final class Torque
      * This method halts the IDBroker's daemon thread in all of
      * the DatabaseMap's. It also closes all SharedPoolDataSourceFactories
      * and PerUserPoolDataSourceFactories initialized by Torque.
-     * @exception TorqueException if a DataSourceFactory could not be closed
+     *
+     * @throws TorqueException if a DataSourceFactory could not be closed
      *            cleanly. Only the first exception is rethrown, any following
      *            exceptions are logged but ignored.
      */
@@ -280,6 +275,7 @@ public final class Torque
      * This method returns a Connection from the default pool.
      *
      * @return The requested connection.
+     *
      * @throws TorqueException Any exceptions caught during processing will be
      *         rethrown wrapped into a TorqueException.
      */
@@ -293,7 +289,9 @@ public final class Torque
      * This method returns a Connecton using the given database name.
      *
      * @param name The database name.
-     * @return a database connection
+     *
+     * @return a database connection to the database with the given name.
+     *
      * @throws TorqueException Any exceptions caught during processing will be
      *         rethrown wrapped into a TorqueException.
      */
@@ -311,7 +309,9 @@ public final class Torque
      * @param name The database name.
      * @param username The name of the database user.
      * @param password The password of the database user.
-     * @return A Connection.
+     *
+     * @return A Connection to the database with the given name.
+     *
      * @throws TorqueException Any exceptions caught during processing will be
      *         rethrown wrapped into a TorqueException.
      */
@@ -361,7 +361,8 @@ public final class Torque
      * Sets the current schema for a database connection
      *
      * @param name The database name.
-     * @param schema The current schema name
+     * @param schema The current schema name.
+     *
      * @throws TorqueException Any exceptions caught during processing will be
      *         rethrown wrapped into a TorqueException.
      */
@@ -375,7 +376,9 @@ public final class Torque
      * This method returns the current schema for a database connection
      *
      * @param name The database name.
+     *
      * @return The current schema name. Null means, no schema has been set.
+     *
      * @throws TorqueException Any exceptions caught during processing will be
      *         rethrown wrapped into a TorqueException.
      */
@@ -413,6 +416,7 @@ public final class Torque
      * properly.
      *
      * @return a Map containing all Databases known to Torque, never null.
+     *
      * @throws TorqueException if Torque is not yet initialized.
      */
     public static Map<String, Database> getDatabases() 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