svn commit: r1088901 - /commons/proper/discovery/trunk/src/java/org/apache/commons/discovery/ResourceClass.java

[simonetripodi]

Author: simonetripodi
Date: Tue Apr  5 05:49:35 2011
New Revision: 1088901

URL: http://svn.apache.org/viewvc?rev=1088901&view=rev
Log:
fixed checkstyle violations

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

Modified: 
commons/proper/discovery/trunk/src/java/org/apache/commons/discovery/ResourceClass.java
URL: 
http://svn.apache.org/viewvc/commons/proper/discovery/trunk/src/java/org/apache/commons/discovery/ResourceClass.java?rev=1088901&r1=1088900&r2=1088901&view=diff
==============================================================================
--- 
commons/proper/discovery/trunk/src/java/org/apache/commons/discovery/ResourceClass.java
 (original)
+++ 
commons/proper/discovery/trunk/src/java/org/apache/commons/discovery/ResourceClass.java
 Tue Apr  5 05:49:35 2011
@@ -31,21 +31,43 @@ import org.apache.commons.logging.Log;
  *
  * I think it works well as it will give users a point-of-reference.
  *
+ * @param <T> The SPI type
+ *
  * @author Richard A. Sitze
  */
 public class ResourceClass<T> extends Resource
 {
     private static Log log = DiscoveryLogFactory.newLog(ResourceClass.class);
+
+    /**
+     * Sets the {@code Log} for this class.
+     *
+     * @param _log This class {@code Log}
+     */
     public static void setLog(Log _log) {
         log = _log;
     }
     protected Class<? extends T>       resourceClass;
 
+    /**
+     * Create a new {@code Resource} class located by discovery.
+     *
+     * @param <S> Any type extends T
+     * @param resourceClass The resource class has to be located
+     * @param resource The resource URL has to be located
+     */
     public <S extends T> ResourceClass(Class<S> resourceClass, URL resource) {
         super(resourceClass.getName(), resource, 
resourceClass.getClassLoader());
         this.resourceClass = resourceClass;
     }
 
+    /**
+     * Create a new {@code Resource} class located by discovery.
+     *
+     * @param resourceName The resource class name has to be located
+     * @param resource The resource URL has to be located
+     * @param loader The class loaders holder
+     */
     public ResourceClass(String resourceName, URL resource, ClassLoader 
loader) {
         super(resourceName, resource, loader);
     }
@@ -64,6 +86,8 @@ public class ResourceClass<T> extends Re
      * java.lang.newInstance (JDK13),
      * and who knows what else..
      *
+     * @param <S> Any type extends T
+     *
      * @return value of resourceClass.
      */
     public <S extends T> Class<S> loadClass() {
@@ -90,6 +114,9 @@ public class ResourceClass<T> extends Re
         return returned;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public String toString() {
         return "ResourceClass[" + getName() +  ", " + getResource() + ", " + 
getClassLoader() + "]";