mcconnell 2003/01/09 04:13:42
Modified: fortress/src/java/org/apache/excalibur/fortress/handler
AbstractComponentHandler.java ComponentFactory.java
Log:
javadoc
Revision Changes Path
1.44 +5 -4
jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/handler/AbstractComponentHandler.java
Index: AbstractComponentHandler.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/handler/AbstractComponentHandler.java,v
retrieving revision 1.43
retrieving revision 1.44
diff -u -r1.43 -r1.44
--- AbstractComponentHandler.java 4 Dec 2002 12:21:03 -0000 1.43
+++ AbstractComponentHandler.java 9 Jan 2003 12:13:42 -0000 1.44
@@ -65,9 +65,7 @@
* AbstractComponentHandler class, ensures components are initialized
* and destroyed correctly.
*
- * @author <a href="mailto:[EMAIL PROTECTED]">Berin Loritsch</a>
- * @author <a href="mailto:[EMAIL PROTECTED]">Marcus Crafter</a>
- * @author <a href="mailto:[EMAIL PROTECTED]">Peter Donald</a>
+ * @author <a href="mailto:avalon-dev@jakarta.apache.org";>Avalon Development
Team</a>
* @version CVS $Revision$ $Date$
* @since 4.0
*/
@@ -183,6 +181,7 @@
/**
* Get a reference of the desired Component
+ * @return the component
*/
public Object get()
throws Exception
@@ -217,6 +216,7 @@
/**
* Return a reference of the desired Component
+ * @param component the component
*/
public void put( final Object component )
{
@@ -321,6 +321,7 @@
/**
* Represents the handler as a string.
+ * @return the string representation of the handler
*/
public String toString()
{
1.39 +37 -2
jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/handler/ComponentFactory.java
Index: ComponentFactory.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/handler/ComponentFactory.java,v
retrieving revision 1.38
retrieving revision 1.39
diff -u -r1.38 -r1.39
--- ComponentFactory.java 24 Nov 2002 16:45:19 -0000 1.38
+++ ComponentFactory.java 9 Jan 2003 12:13:42 -0000 1.39
@@ -154,6 +154,15 @@
m_dispose = new CounterInstrument( "destroys" );
}
+ /**
+ * Returns a new instance of a component and optionally applies a logging
channel,
+ * instrumentation, context, a component or service manager,
configuration, parameters,
+ * lifecycle extensions, initialization, and execution phases based on
the interfaces
+ * implemented by the component class.
+ *
+ * @return the new instance
+ * @exception of
+ */
public Object newInstance()
throws Exception
{
@@ -253,11 +262,20 @@
return logger;
}
+ /**
+ * Returns the component class.
+ * @return the class
+ */
public final Class getCreatedClass()
{
return m_componentClass;
}
+ /**
+ * Disposal of the supplied component instance.
+ * @param component the component to dispose of
+ * @exception Exception if a disposal error occurs
+ */
public final void dispose( final Object component )
throws Exception
{
@@ -287,17 +305,29 @@
}
}
+ /**
+ * Set the instrumentable name
+ * @param name the name
+ */
public final void setInstrumentableName( String name )
{
// ignore
}
+ /**
+ * Returns the instrumentable name
+ * @return the name
+ */
public final String getInstrumentableName()
{
return m_instrumentableName;
}
- public final Instrument[] getInstruments()
+ /**
+ * Returns the set of instruments assigned to the component factory.
+ * @return the instruments
+ */
+ public final Instrument[] getInstruments()
{
return new Instrument[]
{
@@ -306,6 +336,11 @@
};
}
+ /**
+ * Returns the set of child instrumentables. The default implementation
+ * simply returns an empty instrumentable array.
+ * @return the instrumentables
+ */
public final Instrumentable[] getChildInstrumentables()
{
return Instrumentable.EMPTY_INSTRUMENTABLE_ARRAY;
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
