[jboss-cvs] JBossAS SVN: r62615 - projects/microcontainer/trunk/varia/osgi-api/repository/src/main/org/osgi/service/obr.

[jboss-cvs-commits at lists.jboss.org]

Author: alesj
Date: 2007-04-27 11:55:21 -0400 (Fri, 27 Apr 2007)
New Revision: 62615

Modified:
   projects/microcontainer/trunk/varia/osgi-api/repository/src/main/org/osgi/service/obr/Capability.java
   projects/microcontainer/trunk/varia/osgi-api/repository/src/main/org/osgi/service/obr/Repository.java
   projects/microcontainer/trunk/varia/osgi-api/repository/src/main/org/osgi/service/obr/RepositoryAdmin.java
   projects/microcontainer/trunk/varia/osgi-api/repository/src/main/org/osgi/service/obr/Requirement.java
   projects/microcontainer/trunk/varia/osgi-api/repository/src/main/org/osgi/service/obr/Resource.java
Log:
javadocs

Modified: projects/microcontainer/trunk/varia/osgi-api/repository/src/main/org/osgi/service/obr/Capability.java
===================================================================
--- projects/microcontainer/trunk/varia/osgi-api/repository/src/main/org/osgi/service/obr/Capability.java	2007-04-27 15:29:12 UTC (rev 62614)
+++ projects/microcontainer/trunk/varia/osgi-api/repository/src/main/org/osgi/service/obr/Capability.java	2007-04-27 15:55:21 UTC (rev 62615)
@@ -35,7 +35,8 @@
 {
     /**
      * Return the name of the capability.
-     * 
+     *
+     * @return name
      */
     String getName();
 

Modified: projects/microcontainer/trunk/varia/osgi-api/repository/src/main/org/osgi/service/obr/Repository.java
===================================================================
--- projects/microcontainer/trunk/varia/osgi-api/repository/src/main/org/osgi/service/obr/Repository.java	2007-04-27 15:29:12 UTC (rev 62614)
+++ projects/microcontainer/trunk/varia/osgi-api/repository/src/main/org/osgi/service/obr/Repository.java	2007-04-27 15:55:21 UTC (rev 62615)
@@ -34,12 +34,15 @@
 {
     /**
      * Return the associated URL for the repository.
-     * 
+     *
+     * @return url
      */
     URL getURL();
 
     /**
      * Return the resources for this repository.
+     *
+     * @return resource
      */
     Resource[] getResources();
 

Modified: projects/microcontainer/trunk/varia/osgi-api/repository/src/main/org/osgi/service/obr/RepositoryAdmin.java
===================================================================
--- projects/microcontainer/trunk/varia/osgi-api/repository/src/main/org/osgi/service/obr/RepositoryAdmin.java	2007-04-27 15:29:12 UTC (rev 62614)
+++ projects/microcontainer/trunk/varia/osgi-api/repository/src/main/org/osgi/service/obr/RepositoryAdmin.java	2007-04-27 15:55:21 UTC (rev 62615)
@@ -77,8 +77,7 @@
     /**
      * Create a resolver.
      * 
-     * @param resource
-     * @return
+     * @return resolver
      */
     Resolver resolver();
 
@@ -87,20 +86,32 @@
      * 
      * The url must point to a repository XML file.
      * 
-     * @param repository
-     * @return
-     * @throws Exception
+     * @param repository respository's url
+     * @return repository
+     * @throws Exception for any exception
      */
     Repository addRepository(URL repository) throws Exception;
 
+   /**
+    * Remove the repository under repository param.
+    *
+    * @param repository the respoitory url
+    * @return true if removed, false otherwise
+    */
     boolean removeRepository(URL repository);
 
     /**
      * List all the repositories.
      * 
-     * @return
+     * @return repositories array
      */
     Repository[] listRepositories();
 
+   /**
+    * Get repository by id.
+    *
+    * @param respositoryId repository id
+    * @return the respository by id
+    */
     Resource getResource(String respositoryId);
 }
\ No newline at end of file

Modified: projects/microcontainer/trunk/varia/osgi-api/repository/src/main/org/osgi/service/obr/Requirement.java
===================================================================
--- projects/microcontainer/trunk/varia/osgi-api/repository/src/main/org/osgi/service/obr/Requirement.java	2007-04-27 15:29:12 UTC (rev 62614)
+++ projects/microcontainer/trunk/varia/osgi-api/repository/src/main/org/osgi/service/obr/Requirement.java	2007-04-27 15:55:21 UTC (rev 62615)
@@ -34,22 +34,51 @@
 
     /**
      * Return the name of the requirement.
+     *
+     * @return name
      */
     String getName();
 
     /**
      * Return the filter.
-     * 
+     *
+     * @return filter string
      */
     String getFilter();
 
+   /**
+    * Is multiple.
+    *
+    * @return true for multiple, false otherwise
+    */
     boolean isMultiple();
 
+   /**
+    * Is optional.
+    *
+    * @return true for optional, false otherwise
+    */
     boolean isOptional();
 
+   /**
+    * Is extended.
+    *
+    * @return true for extended, false otherwise
+    */
     boolean isExtend();
 
+   /**
+    * Get comment.
+    *
+    * @return the comment
+    */
     String getComment();
 
+   /**
+    * Is satisfied.
+    *
+    * @param capability the capability to check
+    * @return true for satisfied, false otherwise
+    */
     boolean isSatisfied(Capability capability);
 }
\ No newline at end of file

Modified: projects/microcontainer/trunk/varia/osgi-api/repository/src/main/org/osgi/service/obr/Resource.java
===================================================================
--- projects/microcontainer/trunk/varia/osgi-api/repository/src/main/org/osgi/service/obr/Resource.java	2007-04-27 15:29:12 UTC (rev 62614)
+++ projects/microcontainer/trunk/varia/osgi-api/repository/src/main/org/osgi/service/obr/Resource.java	2007-04-27 15:55:21 UTC (rev 62615)
@@ -66,23 +66,73 @@
 
     // get readable name
 
+   /**
+    * Get the properties.
+    *
+    * @return proipersties as map
+    */
     Map getProperties();
 
+   /**
+    * Get the symbolic name.
+    *
+    * @return symbolic name
+    */
     String getSymbolicName();
 
+   /**
+    * Get the presentation name.
+    *
+    * @return presentation name
+    */
     String getPresentationName();
 
+   /**
+    * Get the version.
+    *
+    * @return version
+    */
     Version getVersion();
 
+   /**
+    * Get the id.
+    *
+    * @return id
+    */
     String getId();
 
+   /**
+    * Get the URL.
+    *
+    * @return url
+    */
     URL getURL();
 
+   /**
+    * Get the requirement array.
+    *
+    * @return requirements
+    */
     Requirement[] getRequirements();
 
+   /**
+    * Get the capabiliteis array.
+    *
+    * @return capabiliteis
+    */
     Capability[] getCapabilities();
 
+   /**
+    * Get the categories.
+    *
+    * @return categories
+    */
     String[] getCategories();
 
+   /**
+    * Get the repository.
+    *
+    * @return repository
+    */
     Repository getRepository();
 }
\ No newline at end of file