mpoeschl 02/03/13 16:06:31
Modified: src/java/org/apache/stratum/component ComponentLoader.java
Log:
javadocs
Revision Changes Path
1.5 +14 -5
jakarta-turbine-stratum/src/java/org/apache/stratum/component/ComponentLoader.java
Index: ComponentLoader.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-stratum/src/java/org/apache/stratum/component/ComponentLoader.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- ComponentLoader.java 13 Mar 2002 19:05:16 -0000 1.4
+++ ComponentLoader.java 14 Mar 2002 00:06:31 -0000 1.5
@@ -63,9 +63,11 @@
import org.apache.stratum.lifecycle.Initializable;
/**
+ * Loader for Components implementing the lifecyle Interfaces.
+ *
* @author <a href="mailto:eric NOSPAM dobbse.net">Eric Dobbs</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>Martin Poeschl</a>
- * @version $Id: ComponentLoader.java,v 1.4 2002/03/13 19:05:16 mpoeschl Exp $
+ * @version $Id: ComponentLoader.java,v 1.5 2002/03/14 00:06:31 mpoeschl Exp $
*/
public class ComponentLoader
{
@@ -88,6 +90,8 @@
/**
* Support method for testing the constructor
+ *
+ * @return the configuration
*/
protected Configuration getConfiguration()
{
@@ -125,17 +129,20 @@
log.info("loading component: name=" + componentName + " class="
+ componentClassName + " config=" + componentConfig);
- loadComponent(componentClassName,componentConfig);
+ loadComponent(componentClassName, componentConfig);
}
}
/**
* load the given component, configure it with the given config
- * file, and initialize it.
+ * file, and initialize it. <br>
+ * The component must implement the <code>Initializable</code> and
+ * <code>Configurable</code> interfaces.
*
+ * @see Initializable
+ * @see Configurable
* @param className the String class name of the component to load
- * @param configFile the String path name of the component's
- * config file
+ * @param configFile the String path name of the component's config file
*/
public void loadComponent(String className, String configFile)
{
@@ -181,6 +188,7 @@
* component.NAME.classname=com.mycompany.components.MyComponent</p>
*
* @param name the String NAME of the component in the classfile
+ * @return the configured classname
*/
private String getComponentClassname(String name)
{
@@ -196,6 +204,7 @@
* component.NAME.config=path/to/your/config</p>
*
* @param name the String NAME of the component in the classfile
+ * @return the configured config file
*/
private String getComponentConfigFile(String name)
{
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
