svn commit: r1084202 - /ofbiz/trunk/framework/base/src/org/ofbiz/base/container/Container.java

[adrianc]

Author: adrianc
Date: Tue Mar 22 14:51:46 2011
New Revision: 1084202

URL: http://svn.apache.org/viewvc?rev=1084202&view=rev
Log:
More Container.java JavaDocs - no functional change.

Modified:
    ofbiz/trunk/framework/base/src/org/ofbiz/base/container/Container.java

Modified: ofbiz/trunk/framework/base/src/org/ofbiz/base/container/Container.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/base/src/org/ofbiz/base/container/Container.java?rev=1084202&r1=1084201&r2=1084202&view=diff
==============================================================================
--- ofbiz/trunk/framework/base/src/org/ofbiz/base/container/Container.java (original)
+++ ofbiz/trunk/framework/base/src/org/ofbiz/base/container/Container.java Tue Mar 22 14:51:46 2011
@@ -32,10 +32,12 @@ package org.ofbiz.base.container;
  * threads.
  * </p>
  *
+ * <p>Containers might be loaded more than once (have more than one instance).<p>
  */
 public interface Container {
 
-    /** Initialize the container.
+    /** Initialize the container. This method must not block - implementations
+     * should initialize internal structures and then return.
      *
      * @param args Command-line arguments.
      * @param configFile Location of the configuration file used to load this container.
@@ -46,7 +48,8 @@ public interface Container {
     public void init(String[] args, String configFile) throws ContainerException;
 
     /**
-     * Start the container process.
+     * Start the container process. This method must not block - implementations
+     * that require thread blocking must create a separate thread and then return.
      *
      * @return <code>true</code> if the process started.
      * @throws ContainerException If an error was encountered.
@@ -54,7 +57,7 @@ public interface Container {
     public boolean start() throws ContainerException;
 
     /**
-     * Stop the container process.
+     * Stop the container process. This method must not block.
      *
      * @throws ContainerException If an error was encountered.
      */