commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From simonetrip...@apache.org
Subject svn commit: r1088942 - /commons/proper/discovery/trunk/src/java/org/apache/commons/discovery/Resource.java
Date Tue, 05 Apr 2011 09:45:08 GMT
Author: simonetripodi
Date: Tue Apr  5 09:45:07 2011
New Revision: 1088942

URL: http://svn.apache.org/viewvc?rev=1088942&view=rev
Log:
added missing javadoc comments

Modified:
    commons/proper/discovery/trunk/src/java/org/apache/commons/discovery/Resource.java

Modified: commons/proper/discovery/trunk/src/java/org/apache/commons/discovery/Resource.java
URL: http://svn.apache.org/viewvc/commons/proper/discovery/trunk/src/java/org/apache/commons/discovery/Resource.java?rev=1088942&r1=1088941&r2=1088942&view=diff
==============================================================================
--- commons/proper/discovery/trunk/src/java/org/apache/commons/discovery/Resource.java (original)
+++ commons/proper/discovery/trunk/src/java/org/apache/commons/discovery/Resource.java Tue
Apr  5 09:45:07 2011
@@ -36,6 +36,13 @@ public class Resource
     protected final URL         resource;
     protected final ClassLoader loader;
 
+    /**
+     * Create a new {@link Resource} instance.
+     *
+     * @param resourceName The resource name has to be located
+     * @param resource The resource URL has to be located
+     * @param loader The class loader used to locate the given resource
+     */
     public Resource(String resourceName, URL resource, ClassLoader loader) {
         this.name = resourceName;
         this.resource = resource;
@@ -94,12 +101,20 @@ public class Resource
 //        this.loader = loader;
 //    }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public String toString() {
         return "Resource[" + getName() +  ", " + getResource() + ", " + getClassLoader()
+ "]";
     }
 
-
+    /**
+     * Returns an array containing all of the elements in this {@link ResourceIterator} in
proper sequence.
+     *
+     * @param iterator The {@link ResourceIterator} containing the 
+     * @return An array containing the elements of the given {@link ResourceIterator}
+     */
     public static Resource[] toArray(ResourceIterator iterator) {
         List<Resource> resourceList = new LinkedList<Resource>();
         while (iterator.hasNext()) {



Mime
View raw message