Author: vmassol
Date: 2008-01-31 15:23:44 +0100 (Thu, 31 Jan 2008)
New Revision: 7241
Modified:
xwiki-platform/core/trunk/xwiki-component/src/main/java/org/xwiki/component/phase/Initializable.java
xwiki-platform/core/trunk/xwiki-velocity/src/main/java/org/xwiki/velocity/DefaultVelocityManager.java
Log:
Added some javadoc
Modified:
xwiki-platform/core/trunk/xwiki-component/src/main/java/org/xwiki/component/phase/Initializable.java
===================================================================
---
xwiki-platform/core/trunk/xwiki-component/src/main/java/org/xwiki/component/phase/Initializable.java
2008-01-31 13:55:09 UTC (rev 7240)
+++
xwiki-platform/core/trunk/xwiki-component/src/main/java/org/xwiki/component/phase/Initializable.java
2008-01-31 14:23:44 UTC (rev 7241)
@@ -20,7 +20,19 @@
*/
package org.xwiki.component.phase;
+/**
+ * @see #initialize()
+ */
public interface Initializable
{
+ /**
+ * Method called by the Component Manager when the component is created
for the first time
+ * (i.e. when it's looked up for the first time or if the component is
specified as being
+ * loaded on startup). If the component instantiation strategy is
singleton then this
+ * method is called only once during the lifecycle of the cOmponent
Manager. Otherwise
+ * the component is created at each lookup and thus this method is called
at each lookup yoo.
+ *
+ * @throws InitializationException if an error happens during a
component's initialization
+ */
void initialize() throws InitializationException;
}
\ No newline at end of file
Modified:
xwiki-platform/core/trunk/xwiki-velocity/src/main/java/org/xwiki/velocity/DefaultVelocityManager.java
===================================================================
---
xwiki-platform/core/trunk/xwiki-velocity/src/main/java/org/xwiki/velocity/DefaultVelocityManager.java
2008-01-31 13:55:09 UTC (rev 7240)
+++
xwiki-platform/core/trunk/xwiki-velocity/src/main/java/org/xwiki/velocity/DefaultVelocityManager.java
2008-01-31 14:23:44 UTC (rev 7241)
@@ -44,7 +44,11 @@
private RuntimeServices runtimeServices;
private Container container;
-
+
+ /**
+ * [EMAIL PROTECTED]
+ * @see org.xwiki.component.phase.Initializable#initialize()
+ */
public void initialize() throws InitializationException
{
this.engine = new VelocityEngine();
_______________________________________________
notifications mailing list
[email protected]
http://lists.xwiki.org/mailman/listinfo/notifications