dlr 01/06/20 01:37:28
Modified: src/java/org/apache/turbine/services BaseServiceBroker.java
Log:
* JavaDoc changes and additions.
* Broke long line(s).
Revision Changes Path
1.34 +34 -37
jakarta-turbine/src/java/org/apache/turbine/services/BaseServiceBroker.java
Index: BaseServiceBroker.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine/src/java/org/apache/turbine/services/BaseServiceBroker.java,v
retrieving revision 1.33
retrieving revision 1.34
diff -u -r1.33 -r1.34
--- BaseServiceBroker.java 2001/06/20 07:42:07 1.33
+++ BaseServiceBroker.java 2001/06/20 08:37:26 1.34
@@ -96,7 +96,7 @@
* @author <a href="mailto:[EMAIL PROTECTED]";>Rafal Krzewski</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>Daniel Rall</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>Jason van Zyl</a>
- * @version $Id: BaseServiceBroker.java,v 1.33 2001/06/20 07:42:07 dlr Exp $
+ * @version $Id: BaseServiceBroker.java,v 1.34 2001/06/20 08:37:26 dlr Exp $
*/
public abstract class BaseServiceBroker implements ServiceBroker
{
@@ -162,9 +162,9 @@
protected String applicationRoot;
/**
- * Default constructor of InitableBorker.
- *
- * This constructor does nothing.
+ * Creates a new vanilla instance of the broker. Protected as a
+ * further hint to avoid using this <code>ServiceBroker</code>
+ * implementation directly.
*/
protected BaseServiceBroker()
{
@@ -206,9 +206,9 @@
}
/**
- * Get the log4j Category used for logging.
+ * Get the log4j <code>Category</code> used for logging.
*
- * @return Category
+ * @return The logger for this broker.
*/
public Category getCategory()
{
@@ -241,12 +241,11 @@
}
/**
- * Set an application specific service object
- * that can be used by application specific
- * services.
+ * Sets an application specific service object that can be used by
+ * application specific services.
*
- * @param String name of service object
- * @param Object value of service object
+ * @param name The name of the service object.
+ * @param value The value of service object.
*/
public void setServiceObject(String name, Object value)
{
@@ -254,9 +253,9 @@
}
/**
- * Get an application specific service object.
+ * Retrieves an application specific service object.
*
- * @return Object application specific service object
+ * @return Object An application specific service object.
*/
public Object getServiceObject(String name)
{
@@ -302,14 +301,16 @@
{
String key = (String)keys.next();
- if(key.startsWith(SERVICE_PREFIX) && key.endsWith(CLASSNAME_SUFFIX))
+ if (key.startsWith(SERVICE_PREFIX) &&
+ key.endsWith(CLASSNAME_SUFFIX))
{
String serviceKey = key.substring(pref, key.length() - suff);
notice ("Added Mapping for Service: " + serviceKey);
if (! mapping.containsKey(serviceKey))
{
- mapping.setProperty(serviceKey, configuration.getString(key));
+ mapping.setProperty(serviceKey,
+ configuration.getString(key));
}
}
}
@@ -335,14 +336,14 @@
}
/**
- * Shuts down an <code>Initable</code>.
- *
- * This method is used to release resources allocated by an
- * <code>Initable</code>, and return it to its initial (uninitailized)
- * state.
- *
- * @param className The name of the class to be uninitialized.
- */
+ * Shuts down a <code>Service</code>.
+ *
+ * This method is used to release resources allocated by an
+ * <code>Service</code>, and return it to its initial (uninitailized)
+ * state.
+ *
+ * @param className The name of the service to be uninitialized.
+ */
public void shutdownClass(String className)
{
try
@@ -387,8 +388,8 @@
}
/**
- * Returns an Iterator over all known service names beginning with
- * the provided prefix.
+ * Returns an <code>Iterator</code> over all known service names
+ * beginning with the provided prefix.
*
* @param prefix The prefix against which to test.
* @return An Iterator of service names which match the prefix.
@@ -603,10 +604,11 @@
}
if (!service.getInit())
{
- // this exception will be caught & rethrown by this very method.
- // getInit() returning false indicates some initialization issue,
- // which in turn prevents the InitableBroker from passing a
- // reference to a working instance of the initable to the client.
+ // This exception will be caught & rethrown by this
+ // very method. getInit() returning false indicates
+ // some initialization issue, which in turn prevents
+ // the InitableBroker from passing a reference to a
+ // working instance of the initable to the client.
throw new InitializationException(
"init() failed to initialize service " + name);
}
@@ -796,10 +798,9 @@
}
/**
- * Get the application root as set by
- * the parent application.
+ * Get the application root as set by the parent application.
*
- * @return String application root
+ * @return String The application root for this broker.
*/
public String getApplicationRoot()
{
@@ -807,11 +808,7 @@
}
/**
- * Gets the version of the supplied path as relative to appliation
- * root. Does not demand strict adherence to the Servlet API's
- * definition of <code>getRealPath()</code>.
- *
- * @return The path, relative to application root.
+ * @see org.apache.turbine.services.ServiceBroker#getRealPath
*/
public String getRealPath(String path)
{
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
