svn commit: r932215 - /incubator/aries/trunk/subsystem/subsystem-api/src/main/java/org/apache/aries/subsystem/SubsystemAdmin.java

[li...@apache.org]

Author: linsun
Date: Fri Apr  9 02:23:16 2010
New Revision: 932215

URL: http://svn.apache.org/viewvc?rev=932215&view=rev
Log:
add a bit more javadoc for the install methods

Modified:
    incubator/aries/trunk/subsystem/subsystem-api/src/main/java/org/apache/aries/subsystem/SubsystemAdmin.java

Modified: incubator/aries/trunk/subsystem/subsystem-api/src/main/java/org/apache/aries/subsystem/SubsystemAdmin.java
URL: http://svn.apache.org/viewvc/incubator/aries/trunk/subsystem/subsystem-api/src/main/java/org/apache/aries/subsystem/SubsystemAdmin.java?rev=932215&r1=932214&r2=932215&view=diff
==============================================================================
--- incubator/aries/trunk/subsystem/subsystem-api/src/main/java/org/apache/aries/subsystem/SubsystemAdmin.java (original)
+++ incubator/aries/trunk/subsystem/subsystem-api/src/main/java/org/apache/aries/subsystem/SubsystemAdmin.java Fri Apr  9 02:23:16 2010
@@ -47,7 +47,10 @@ public interface SubsystemAdmin {
     Subsystem getSubsystem(String scope);
 
     /**
-     * Install a new subsystem.
+     * Install a new subsystem from the specified location identifier.
+     * 
+     * This method performs the same function as calling <code>install(String, InputStream)</code> with the specified 
+     * location identifier and a null InputStream.
      *
      * @param location
      * @return
@@ -55,8 +58,14 @@ public interface SubsystemAdmin {
     Subsystem install(String location) throws SubsystemException;
 
     /**
-     * Install a new subsystem.
-     *
+     * Install a new subsystem from the specified InputStream object.  If the specified InputStream is null,
+     * the InputStream must be created from the specified location.
+     * 
+     * The specified location identifier will be used as the identity of the subsystem. 
+     * Every installed subsystem is uniquely identified by its location identifier which is typically in the form of a URL.
+     * 
+     * If a subsystem containing the same location identifier is already installed, the Subsystem object for that subsystem is returned.
+     * 
      * @param location
      * @param content
      * @return