tomdz 2005/12/22 13:24:51
Modified: src/java/org/apache/ojb/broker Tag: OJB_1_0_RELEASE
PersistenceBrokerFactory.java
Log:
Updated Javadoc
Revision Changes Path
No revision
No revision
1.23.2.3 +31 -7
db-ojb/src/java/org/apache/ojb/broker/PersistenceBrokerFactory.java
Index: PersistenceBrokerFactory.java
===================================================================
RCS file:
/home/cvs/db-ojb/src/java/org/apache/ojb/broker/PersistenceBrokerFactory.java,v
retrieving revision 1.23.2.2
retrieving revision 1.23.2.3
diff -u -r1.23.2.2 -r1.23.2.3
--- PersistenceBrokerFactory.java 21 Dec 2005 22:22:08 -0000 1.23.2.2
+++ PersistenceBrokerFactory.java 22 Dec 2005 21:24:51 -0000 1.23.2.3
@@ -34,7 +34,7 @@
* Returns the [EMAIL PROTECTED]
org.apache.ojb.broker.util.configuration.Configurator}
* object.
*
- * @return the configurator
+ * @return The configurator
*/
public static Configurator getConfigurator()
{
@@ -42,6 +42,9 @@
}
/**
+ * Sets the key that specifies the default persistence manager.
+ *
+ * @param key The default broker key
* @see
org.apache.ojb.broker.core.PersistenceBrokerFactoryIF#setDefaultKey
*/
public static void setDefaultKey(PBKey key)
@@ -50,6 +53,9 @@
}
/**
+ * Returns the key that specifies the default persistence manager.
+ *
+ * @return The default broker key
* @see
org.apache.ojb.broker.core.PersistenceBrokerFactoryIF#getDefaultKey
*/
public static PBKey getDefaultKey()
@@ -58,6 +64,9 @@
}
/**
+ * Creates a default broker instance for the default broker key.
+ *
+ * @return The persistence broker
* @see
org.apache.ojb.broker.core.PersistenceBrokerFactoryIF#defaultPersistenceBroker
*/
public static PersistenceBroker defaultPersistenceBroker() throws
PBFactoryException
@@ -67,26 +76,38 @@
}
/**
+ * Creates a new broker instance.
+ *
+ * @param jcdAlias The jdbc connection descriptor name as defined in the
repository
+ * @param user The user name to be used for connecting to the
database
+ * @param password The password to be used for connecting to the database
+ * @return The persistence broker
* @see
org.apache.ojb.broker.core.PersistenceBrokerFactoryIF#createPersistenceBroker(java.lang.String,
java.lang.String, java.lang.String)
*/
public static PersistenceBroker createPersistenceBroker(String jcdAlias,
- String user,
String password)
- throws PBFactoryException
+ String user,
+ String password)
throws PBFactoryException
{
return PersistenceBrokerFactoryFactory.instance().
- createPersistenceBroker(jcdAlias, user, password);
+ createPersistenceBroker(jcdAlias, user, password);
}
/**
+ * Creates a new broker instance for the given key.
+ *
+ * @param key The broker key
+ * @return The persistence broker
* @see
org.apache.ojb.broker.core.PersistenceBrokerFactoryIF#createPersistenceBroker(org.apache.ojb.broker.PBKey)
*/
- public static PersistenceBroker createPersistenceBroker(PBKey key)
- throws PBFactoryException
+ public static PersistenceBroker createPersistenceBroker(PBKey key)
throws PBFactoryException
{
return
PersistenceBrokerFactoryFactory.instance().createPersistenceBroker(key);
}
/**
+ * Releases all broker instances pooled by this factory (if any). Note
that the broker are
+ * closed prior to releasing them.
+ *
* @see
org.apache.ojb.broker.core.PersistenceBrokerFactoryIF#releaseAllInstances
*/
public static void releaseAllInstances()
@@ -95,6 +116,9 @@
}
/**
+ * Shuts OJB down, i.e. releases all resources. You should not use any
OJB functionality
+ * after calling this method.
+ *
* @see org.apache.ojb.broker.core.PersistenceBrokerFactoryIF#shutdown()
*/
public static void shutdown()
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
