dlr 01/06/20 01:43:37
Modified: src/java/org/apache/turbine/services Service.java
Log:
Brought JavaDoc more in sync with the reality of 2.2-dev.
Revision Changes Path
1.13 +12 -10
jakarta-turbine/src/java/org/apache/turbine/services/Service.java
Index: Service.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine/src/java/org/apache/turbine/services/Service.java,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- Service.java 2001/06/20 08:35:22 1.12
+++ Service.java 2001/06/20 08:43:34 1.13
@@ -63,8 +63,10 @@
import org.apache.velocity.runtime.configuration.Configuration;
/**
- * <code>Services</code> are <code>Initables</code> that have a name,
- * and a set of properties.
+ * <code>Service</code> implementations are pluggable, initializable
+ * singletons brokered by a manager class implementing the
+ * <code>ServiceBroker</code> interface. Turbine's default
+ * implementation is the <code>TurbineServices</code> singleton.
*
* @author <a href="mailto:[EMAIL PROTECTED]";>Greg Ritter</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>Brett McLaughlin</a>
@@ -73,7 +75,7 @@
* @author <a href="mailto:[EMAIL PROTECTED]";>Daniel Rall</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>Jason van Zyl</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>Leonard Richardson</a>
- * @version $Id: Service.java,v 1.12 2001/06/20 08:35:22 dlr Exp $
+ * @version $Id: Service.java,v 1.13 2001/06/20 08:43:34 dlr Exp $
*/
public interface Service
{
@@ -83,7 +85,7 @@
public static final String SERVICE_NAME = "Service";
/**
- * Performs early initailization of an Initable
+ * Performs early initailization of a Service
*
* During the startup of the system, different objects may be
* passed to your class using this method. It should ignore any
@@ -105,9 +107,9 @@
throws InitializationException;
/**
- * Performs late initialization of an Initable.
+ * Performs late initialization of a Service.
*
- * When your class is being requested from an InitableBroker, it
+ * When your class is being requested from a ServiceBroker, it
* will call getInit(), and if it returns false, this method will
* be invoked.
*
@@ -117,10 +119,10 @@
public void init( ) throws InitializationException;
/**
- * Returns an <code>Initable</code> to an uninitialized state.
+ * Returns an <code>Service</code> to an uninitialized state.
*
* <p>This method must release all resources allocated by the
- * <code>Initable</code> implementation, and resetting its internal state.
+ * <code>Service</code> implementation, and resetting its internal state.
* You may chose to implement this operation or not. If you support
* this operation, getInit() should return false after successful
* shutdown of the service.
@@ -128,9 +130,9 @@
public void shutdown( );
/**
- * Returns initialization status of an Initable.
+ * Returns initialization status of a Service.
*
- * @return Initialization status of an Initable.
+ * @return Initialization status of a Service.
*/
public boolean getInit( );
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
