You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by jc...@apache.org on 2008/02/21 20:22:51 UTC

svn commit: r629947 - in /commons/proper/proxy/branches/proxy-1.0-work/src/main/java/org/apache/commons/proxy/factory/util: AbstractSubclassingProxyFactory.java MethodSignature.java ProxyClassCache.java ProxyClassGenerator.java

Author: jcarman
Date: Thu Feb 21 11:22:49 2008
New Revision: 629947

URL: http://svn.apache.org/viewvc?rev=629947&view=rev
Log:
Improving javadocs.

Modified:
    commons/proper/proxy/branches/proxy-1.0-work/src/main/java/org/apache/commons/proxy/factory/util/AbstractSubclassingProxyFactory.java
    commons/proper/proxy/branches/proxy-1.0-work/src/main/java/org/apache/commons/proxy/factory/util/MethodSignature.java
    commons/proper/proxy/branches/proxy-1.0-work/src/main/java/org/apache/commons/proxy/factory/util/ProxyClassCache.java
    commons/proper/proxy/branches/proxy-1.0-work/src/main/java/org/apache/commons/proxy/factory/util/ProxyClassGenerator.java

Modified: commons/proper/proxy/branches/proxy-1.0-work/src/main/java/org/apache/commons/proxy/factory/util/AbstractSubclassingProxyFactory.java
URL: http://svn.apache.org/viewvc/commons/proper/proxy/branches/proxy-1.0-work/src/main/java/org/apache/commons/proxy/factory/util/AbstractSubclassingProxyFactory.java?rev=629947&r1=629946&r2=629947&view=diff
==============================================================================
--- commons/proper/proxy/branches/proxy-1.0-work/src/main/java/org/apache/commons/proxy/factory/util/AbstractSubclassingProxyFactory.java (original)
+++ commons/proper/proxy/branches/proxy-1.0-work/src/main/java/org/apache/commons/proxy/factory/util/AbstractSubclassingProxyFactory.java Thu Feb 21 11:22:49 2008
@@ -27,6 +27,8 @@
 import java.util.List;
 
 /**
+ * A useful superclass for a {@link ProxyFactory} which supports subclassing rather than merely implementing interfaces.
+ * 
  * @author James Carman
  * @since 1.0
  */

Modified: commons/proper/proxy/branches/proxy-1.0-work/src/main/java/org/apache/commons/proxy/factory/util/MethodSignature.java
URL: http://svn.apache.org/viewvc/commons/proper/proxy/branches/proxy-1.0-work/src/main/java/org/apache/commons/proxy/factory/util/MethodSignature.java?rev=629947&r1=629946&r2=629947&view=diff
==============================================================================
--- commons/proper/proxy/branches/proxy-1.0-work/src/main/java/org/apache/commons/proxy/factory/util/MethodSignature.java (original)
+++ commons/proper/proxy/branches/proxy-1.0-work/src/main/java/org/apache/commons/proxy/factory/util/MethodSignature.java Thu Feb 21 11:22:49 2008
@@ -22,6 +22,8 @@
 import java.util.List;
 
 /**
+ * A class for capturing the signature of a method (its name and parameter types).
+ * 
  * @author James Carman
  * @since 1.0
  */

Modified: commons/proper/proxy/branches/proxy-1.0-work/src/main/java/org/apache/commons/proxy/factory/util/ProxyClassCache.java
URL: http://svn.apache.org/viewvc/commons/proper/proxy/branches/proxy-1.0-work/src/main/java/org/apache/commons/proxy/factory/util/ProxyClassCache.java?rev=629947&r1=629946&r2=629947&view=diff
==============================================================================
--- commons/proper/proxy/branches/proxy-1.0-work/src/main/java/org/apache/commons/proxy/factory/util/ProxyClassCache.java (original)
+++ commons/proper/proxy/branches/proxy-1.0-work/src/main/java/org/apache/commons/proxy/factory/util/ProxyClassCache.java Thu Feb 21 11:22:49 2008
@@ -23,6 +23,10 @@
 import java.util.WeakHashMap;
 
 /**
+ * A cache for storing implementation classes for proxies based on a specific type of {@link ProxyClassGenerator}.  A
+ * proxy class cache ensures that there is only one class for every
+ * {@link ProxyClassGenerator}/{@link ClassLoader}/proxy class array combination.
+ *
  * @author James Carman
  * @since 1.0
  */
@@ -48,6 +52,15 @@
 // Other Methods
 //----------------------------------------------------------------------------------------------------------------------
 
+    /**
+     * Returns the proxy class generated by the {@link ProxyClassGenerator} using the specified {@link ClassLoader} and
+     * array of proxy classes.
+     * 
+     * @param classLoader the classloader
+     * @param proxyClasses the proxy classes
+     * @return the proxy class generated by the {@link ProxyClassGenerator} using the specified {@link ClassLoader} and
+     * array of proxy classes
+     */
     public synchronized Class getProxyClass( ClassLoader classLoader, Class[] proxyClasses )
     {
         final Map classCache = getClassCache( classLoader );

Modified: commons/proper/proxy/branches/proxy-1.0-work/src/main/java/org/apache/commons/proxy/factory/util/ProxyClassGenerator.java
URL: http://svn.apache.org/viewvc/commons/proper/proxy/branches/proxy-1.0-work/src/main/java/org/apache/commons/proxy/factory/util/ProxyClassGenerator.java?rev=629947&r1=629946&r2=629947&view=diff
==============================================================================
--- commons/proper/proxy/branches/proxy-1.0-work/src/main/java/org/apache/commons/proxy/factory/util/ProxyClassGenerator.java (original)
+++ commons/proper/proxy/branches/proxy-1.0-work/src/main/java/org/apache/commons/proxy/factory/util/ProxyClassGenerator.java Thu Feb 21 11:22:49 2008
@@ -18,6 +18,8 @@
 package org.apache.commons.proxy.factory.util;
 
 /**
+ * A proxy class generator generates specific type of proxies (interceptor, invoker, etc.).
+ * 
  * @author James Carman
  * @since 1.0
  */
@@ -27,6 +29,12 @@
 // Other Methods
 //----------------------------------------------------------------------------------------------------------------------
 
+    /**
+     * Generates a proxy class for the supplied {@link ClassLoader} and proxy classes.
+     * @param classLoader the classloader
+     * @param proxyClasses the proxy classes
+     * @return the dynamically generated proxy class
+     */
     public Class generateProxyClass( ClassLoader classLoader, Class[] proxyClasses );
 }