commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From brit...@apache.org
Subject svn commit: r1442739 - /commons/sandbox/beanutils2/trunk/src/main/java/org/apache/commons/beanutils2/ClassLoaderBuilder.java
Date Tue, 05 Feb 2013 20:54:31 GMT
Author: britter
Date: Tue Feb  5 20:54:31 2013
New Revision: 1442739

URL: http://svn.apache.org/viewvc?rev=1442739&view=rev
Log:
Add JavaDoc for ClassLoaderBuilder - no functional changes

Modified:
    commons/sandbox/beanutils2/trunk/src/main/java/org/apache/commons/beanutils2/ClassLoaderBuilder.java

Modified: commons/sandbox/beanutils2/trunk/src/main/java/org/apache/commons/beanutils2/ClassLoaderBuilder.java
URL: http://svn.apache.org/viewvc/commons/sandbox/beanutils2/trunk/src/main/java/org/apache/commons/beanutils2/ClassLoaderBuilder.java?rev=1442739&r1=1442738&r2=1442739&view=diff
==============================================================================
--- commons/sandbox/beanutils2/trunk/src/main/java/org/apache/commons/beanutils2/ClassLoaderBuilder.java
(original)
+++ commons/sandbox/beanutils2/trunk/src/main/java/org/apache/commons/beanutils2/ClassLoaderBuilder.java
Tue Feb  5 20:54:31 2013
@@ -1,5 +1,6 @@
 package org.apache.commons.beanutils2;
 
+
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
@@ -19,13 +20,34 @@ package org.apache.commons.beanutils2;
  * under the License.
  */
 
+/**
+ * Allows to specifies a {@link ClassLoader} for loading a classes by name.
+ */
 public interface ClassLoaderBuilder
 {
 
+    /**
+     * Use the class loader of the currently executing thread for loading the class. In other
words use the class loader
+     * returned by {@code Thread.currentThread().getContextClassLoader()}.
+     *
+     * @return the {@link ClassAccessor} for the class being loaded.
+     */
     ClassAccessor<?> loadWithThreadContextClassLoader();
 
+    /**
+     * Use the class loader that loaded the {@code org.apache.commons.beanutils2.BeanUtils2}
class to load the
+     * class.
+     *
+     * @return the {@link ClassAccessor} for the class being loaded.
+     */
     ClassAccessor<?> loadWithBeanUtilsClassLoader();
 
+    /**
+     * Use a custom {@link ClassLoader} for loading the class.
+     *
+     * @param classLoader the {@link ClassLoader} to load the class.
+     * @return the {@link ClassAccessor} for the class being loaded.
+     */
     ClassAccessor<?> loadWithClassLoader( ClassLoader classLoader );
 
 }



Mime
View raw message