mcconnell 2003/01/09 04:13:29
Modified: fortress/src/java/org/apache/excalibur/fortress/container
ComponentHandlerEntry.java
ComponentHandlerMetaData.java
fortress/src/java/org/apache/excalibur/fortress/container/commands
PrepareHandlerCommand.java
Log:
javadoc
Revision Changes Path
1.4 +2 -2
jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/container/ComponentHandlerEntry.java
Index: ComponentHandlerEntry.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/container/ComponentHandlerEntry.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ComponentHandlerEntry.java 11 Nov 2002 06:28:52 -0000 1.3
+++ ComponentHandlerEntry.java 9 Jan 2003 12:13:28 -0000 1.4
@@ -13,7 +13,7 @@
* This is the container of runtime information about a
* ComponentHandler.
*
- * @author <a href="mailto:peter at apache.org">Peter Donald</a>
+ * @author <a href="mailto:avalon-dev@jakarta.apache.org";>Avalon Development
Team</a>
* @version $Revision$ $Date$
*/
class ComponentHandlerEntry
1.2 +26 -3
jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/container/ComponentHandlerMetaData.java
Index: ComponentHandlerMetaData.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/container/ComponentHandlerMetaData.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ComponentHandlerMetaData.java 11 Nov 2002 06:28:52 -0000 1.1
+++ ComponentHandlerMetaData.java 9 Jan 2003 12:13:28 -0000 1.2
@@ -10,9 +10,9 @@
import org.apache.avalon.framework.configuration.Configuration;
/**
- * A class to containe metadata about a component handler.
+ * A class holding metadata about a component handler.
*
- * @author <a href="mailto:peter at apache.org">Peter Donald</a>
+ * @author <a href="mailto:avalon-dev@jakarta.apache.org";>Avalon Development
Team</a>
* @version $Revision$ $Date$
*/
public class ComponentHandlerMetaData
@@ -22,6 +22,13 @@
private final Configuration m_configuration;
private final boolean m_lazyActivation;
+ /**
+ * Creation of a new container handler meta data instance.
+ * @param name the handler name
+ * @param classname the handler classname
+ * @param configuration the handler configuration
+ * @param laxyActivation the activation policy
+ */
public ComponentHandlerMetaData( final String name,
final String classname,
final Configuration configuration,
@@ -46,21 +53,37 @@
m_lazyActivation = lazyActivation;
}
+ /**
+ * Returns the handler name
+ * @return the handler name
+ */
public String getName()
{
return m_name;
}
+ /**
+ * Returns the handler classname
+ * @return the classname
+ */
public String getClassname()
{
return m_classname;
}
+ /**
+ * Returns the handler configuration
+ * @return the configuration
+ */
public Configuration getConfiguration()
{
return m_configuration;
}
+ /**
+ * Returns the handler activation policy
+ * @return the activation policy
+ */
public boolean isLazyActivation()
{
return m_lazyActivation;
1.4 +11 -2
jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/container/commands/PrepareHandlerCommand.java
Index: PrepareHandlerCommand.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/container/commands/PrepareHandlerCommand.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- PrepareHandlerCommand.java 10 Nov 2002 12:00:17 -0000 1.3
+++ PrepareHandlerCommand.java 9 Jan 2003 12:13:29 -0000 1.4
@@ -57,7 +57,7 @@
/**
* This is the command class to initialize a ComponentHandler
*
- * @author <a href="mailto:[EMAIL PROTECTED]">Berin Loritsch</a>
+ * @author <a href="mailto:avalon-dev@jakarta.apache.org";>Avalon Development
Team</a>
* @version CVS $Revision$ $Date$
*/
public final class PrepareHandlerCommand implements Command
@@ -65,6 +65,11 @@
private final ComponentHandler m_handler;
private final Logger m_logger;
+ /**
+ * Creation of a new prepare handler command.
+ * @param handler the compoent handler
+ * @param logger the logging channel
+ */
public PrepareHandlerCommand( final ComponentHandler handler,
final Logger logger )
{
@@ -72,6 +77,10 @@
m_logger = ( null == logger ) ? new NullLogger() : logger;
}
+ /**
+ * Invoke execution of the handler
+ * @exception Exception if a handler execution exception occurs
+ */
public void execute()
throws Exception
{
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
