svn commit: r347999 - /jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/ProxyFactory.java

[jc...@apache.org]

Author: jcarman
Date: Mon Nov 21 14:01:17 2005
New Revision: 347999

URL: http://svn.apache.org/viewcvs?rev=347999&view=rev
Log:
Improving JavaDocs.

Modified:
    jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/ProxyFactory.java

Modified: jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/ProxyFactory.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/ProxyFactory.java?rev=347999&r1=347998&r2=347999&view=diff
==============================================================================
--- jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/ProxyFactory.java (original)
+++ jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/ProxyFactory.java Mon Nov 21 14:01:17 2005
@@ -22,17 +22,26 @@
 import java.lang.reflect.Proxy;
 
 /**
- * A <code>ProxyFactory</code> essentially encapsulates a "proxying strategy".  All Commons Proxy proxies are created
- * using a <code>ProxyFactory</code>.  So, to change the proxying strategy, simply provide a different
- * <code>ProxyFactory</code> implementation.
+ * A <code>ProxyFactory</code> can be used to create three different &quot;flavors&quot; of proxy objects:
  *
+ * <ul>
+ *   <li>Delegator - the proxy will delegate to an object provided by an {@link ObjectProvider}</li>
+ *   <li>Interceptor - the proxy will pass each method invocation through an {@link Interceptor}</li>
+ *   <li>Invoker - the proxy will allow an {@link Invoker} to handle all method invocations</li>
+ * </ul>
+ *
+ * <p>
+ * Originally, the ProxyFactory class was an interface.  However, to allow for future changes to the
+ * class without breaking binary or semantic compatibility, it has been changed to a concrete class.
+ *
+ * </p>
  * <p>
  * <b>Note</b>: This class uses Java reflection.  For more efficient proxies, try using either
  * {@link org.apache.commons.proxy.factory.cglib.CglibProxyFactory CglibProxyFactory} or
- * {@link org.apache.commons.proxy.factory.javassist.JavassistProxyFactory JavassistProxyFactory}.
- * 
+ * {@link org.apache.commons.proxy.factory.javassist.JavassistProxyFactory JavassistProxyFactory} instead.
+ * </p>
  * @author James Carman
- * @version 1.0
+ * @since 1.0
  */
 public class ProxyFactory
 {



---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org