You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by jc...@apache.org on 2005/08/23 05:22:00 UTC
svn commit: r239313 - in /jakarta/commons/sandbox/proxy/trunk: ./
src/java/org/apache/commons/proxy/exception/
src/java/org/apache/commons/proxy/factory/
src/java/org/apache/commons/proxy/factory/cglib/
src/java/org/apache/commons/proxy/factory/javassi...
Author: jcarman
Date: Mon Aug 22 20:21:54 2005
New Revision: 239313
URL: http://svn.apache.org/viewcvs?rev=239313&view=rev
Log:
Documentation
Modified:
jakarta/commons/sandbox/proxy/trunk/build.xml
jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/exception/ObjectProviderException.java
jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/AbstractProxyFactory.java
jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/cglib/CglibProxyFactory.java
jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/javassist/JavassistProxyFactory.java
jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/reflect/AbstractInvocationHandler.java
jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/reflect/DelegatingInvocationHandler.java
jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/reflect/MethodInterceptorInvocationHandler.java
jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/reflect/ObjectProviderInvocationHandler.java
jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/reflect/ReflectionMethodInvocation.java
jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/reflect/ReflectionProxyFactory.java
jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/interceptor/MethodFilter.java
jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/interceptor/MethodInterceptorChain.java
Modified: jakarta/commons/sandbox/proxy/trunk/build.xml
URL: http://svn.apache.org/viewcvs/jakarta/commons/sandbox/proxy/trunk/build.xml?rev=239313&r1=239312&r2=239313&view=diff
==============================================================================
--- jakarta/commons/sandbox/proxy/trunk/build.xml (original)
+++ jakarta/commons/sandbox/proxy/trunk/build.xml Mon Aug 22 20:21:54 2005
@@ -85,7 +85,7 @@
srcdir="${dir.src.test}"
destdir="${dir.build.test}">
<classpath>
- <pathelement location="${dir.build.java}" />
+ <pathelement location="${dir.build.java}"/>
<fileset refid="runtime-dependencies"/>
<fileset refid="build-dependencies"/>
</classpath>
@@ -97,7 +97,9 @@
</target>
<target name="javadoc" depends="compile-java">
-
+ <mkdir dir="${dir.dist.javadoc}"/>
+ <javadoc destdir="${dir.dist.javadoc}" sourcepath="${dir.src.java}" packagenames="*">
+ </javadoc>
</target>
<target name="dist" depends="build,javadoc">
<mkdir dir="${dir.dist}"/>
Modified: jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/exception/ObjectProviderException.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/exception/ObjectProviderException.java?rev=239313&r1=239312&r2=239313&view=diff
==============================================================================
--- jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/exception/ObjectProviderException.java (original)
+++ jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/exception/ObjectProviderException.java Mon Aug 22 20:21:54 2005
@@ -16,6 +16,9 @@
package org.apache.commons.proxy.exception;
/**
+ * <code>ObjectProvider</code> implementations should throw this exception type
+ * to indicate that there was a problem creating/finding the object.
+ *
* @author James Carman
* @version 1.0
*/
Modified: jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/AbstractProxyFactory.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/AbstractProxyFactory.java?rev=239313&r1=239312&r2=239313&view=diff
==============================================================================
--- jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/AbstractProxyFactory.java (original)
+++ jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/AbstractProxyFactory.java Mon Aug 22 20:21:54 2005
@@ -20,6 +20,7 @@
import org.apache.commons.proxy.ObjectProvider;
/**
+ * A helpful superclass for {@link org.apache.commons.proxy.ProxyFactory} implementations.
* @author James Carman
* @version 1.0
*/
Modified: jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/cglib/CglibProxyFactory.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/cglib/CglibProxyFactory.java?rev=239313&r1=239312&r2=239313&view=diff
==============================================================================
--- jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/cglib/CglibProxyFactory.java (original)
+++ jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/cglib/CglibProxyFactory.java Mon Aug 22 20:21:54 2005
@@ -27,6 +27,9 @@
import java.lang.reflect.Method;
/**
+ * A <a href="http://cglib.sourceforge.net/">CGLIB</a>-based {@link org.apache.commons.proxy.ProxyFactory}
+ * implementation.
+ *
* @author James Carman
* @version 1.0
*/
Modified: jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/javassist/JavassistProxyFactory.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/javassist/JavassistProxyFactory.java?rev=239313&r1=239312&r2=239313&view=diff
==============================================================================
--- jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/javassist/JavassistProxyFactory.java (original)
+++ jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/javassist/JavassistProxyFactory.java Mon Aug 22 20:21:54 2005
@@ -30,6 +30,8 @@
import java.lang.reflect.Method;
/**
+ * A <a href="http://www.jboss.org/products/javassist">Javassist</a>-based {@link org.apache.commons.proxy.ProxyFactory}
+ * implementation.
* @author James Carman
* @version 1.0
*/
Modified: jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/reflect/AbstractInvocationHandler.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/reflect/AbstractInvocationHandler.java?rev=239313&r1=239312&r2=239313&view=diff
==============================================================================
--- jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/reflect/AbstractInvocationHandler.java (original)
+++ jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/reflect/AbstractInvocationHandler.java Mon Aug 22 20:21:54 2005
@@ -19,16 +19,31 @@
import java.lang.reflect.Proxy;
/**
+ * A useful baseclass for implementing invocation handlers.
+ *
* @author James Carman
* @version 1.0
*/
public abstract class AbstractInvocationHandler implements InvocationHandler
{
+ /**
+ * Creates a proxy object which implements the specified proxy interfaces.
+ * @param proxyInterfaces the proxy interfaces
+ * @return a proxy object which implements the specified proxy interfaces
+ */
public Object createProxy( Class... proxyInterfaces )
{
return createProxy( Thread.currentThread().getContextClassLoader(), proxyInterfaces );
}
+ /**
+ * Creates a proxy object which implements the specified proxy interfaces, using the
+ * specified class loader.
+ * @param classLoader the class loader
+ * @param proxyInterfaces the proxy interfaces
+ * @return a proxy object which implements the specified proxy interfaces, using the
+ * specified class loader.
+ */
public Object createProxy( ClassLoader classLoader, Class... proxyInterfaces )
{
return Proxy.newProxyInstance( classLoader, proxyInterfaces, this );
Modified: jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/reflect/DelegatingInvocationHandler.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/reflect/DelegatingInvocationHandler.java?rev=239313&r1=239312&r2=239313&view=diff
==============================================================================
--- jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/reflect/DelegatingInvocationHandler.java (original)
+++ jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/reflect/DelegatingInvocationHandler.java Mon Aug 22 20:21:54 2005
@@ -18,6 +18,8 @@
import java.lang.reflect.Method;
/**
+ * An invocation handler which delegates to another object.
+ *
* @author James Carman
* @version 1.0
*/
@@ -30,11 +32,22 @@
return method.invoke( getDelegate(), args );
}
+ /**
+ * A simplified proxy creation method which merely creates a proxy which supports
+ * all the interfaces implemented by the delegate.
+ * @return a proxy which supports all the interfaces implemented by the delegate
+ */
public Object createProxy()
{
return createProxy( getDelegate().getClass().getInterfaces() );
}
+ /**
+ * A simplified proxy creation method which merely creates a proxy which supports
+ * all the interfaces implemented by the delegate, using the specified class loader.
+ * @return a proxy which supports all the interfaces implemented by the delegate,
+ * using the specified class loader.
+ */
public Object createProxy( ClassLoader classLoader )
{
return createProxy( classLoader, getDelegate().getClass().getInterfaces() );
Modified: jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/reflect/MethodInterceptorInvocationHandler.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/reflect/MethodInterceptorInvocationHandler.java?rev=239313&r1=239312&r2=239313&view=diff
==============================================================================
--- jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/reflect/MethodInterceptorInvocationHandler.java (original)
+++ jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/reflect/MethodInterceptorInvocationHandler.java Mon Aug 22 20:21:54 2005
@@ -20,6 +20,8 @@
import java.lang.reflect.Method;
/**
+ * An invocation handler that passes through a <code>MethodInterceptor</code>.
+ *
* @author James Carman
* @version 1.0
*/
Modified: jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/reflect/ObjectProviderInvocationHandler.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/reflect/ObjectProviderInvocationHandler.java?rev=239313&r1=239312&r2=239313&view=diff
==============================================================================
--- jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/reflect/ObjectProviderInvocationHandler.java (original)
+++ jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/reflect/ObjectProviderInvocationHandler.java Mon Aug 22 20:21:54 2005
@@ -18,6 +18,7 @@
import org.apache.commons.proxy.ObjectProvider;
/**
+ * An invocation handler which delegates to an object supplied by an {@link ObjectProvider}.
* @author James Carman
* @version 1.0
*/
Modified: jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/reflect/ReflectionMethodInvocation.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/reflect/ReflectionMethodInvocation.java?rev=239313&r1=239312&r2=239313&view=diff
==============================================================================
--- jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/reflect/ReflectionMethodInvocation.java (original)
+++ jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/reflect/ReflectionMethodInvocation.java Mon Aug 22 20:21:54 2005
@@ -21,6 +21,8 @@
import java.lang.reflect.Method;
/**
+ * A reflection-based implementation of the <code>MethodInvocation</code> interface.
+ *
* @author James Carman
* @version 1.0
*/
Modified: jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/reflect/ReflectionProxyFactory.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/reflect/ReflectionProxyFactory.java?rev=239313&r1=239312&r2=239313&view=diff
==============================================================================
--- jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/reflect/ReflectionProxyFactory.java (original)
+++ jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/factory/reflect/ReflectionProxyFactory.java Mon Aug 22 20:21:54 2005
@@ -22,6 +22,7 @@
import java.lang.reflect.Proxy;
/**
+ * A JDK proxy-based {@link org.apache.commons.proxy.ProxyFactory} implementation.
* @author James Carman
* @version 1.0
*/
Modified: jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/interceptor/MethodFilter.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/interceptor/MethodFilter.java?rev=239313&r1=239312&r2=239313&view=diff
==============================================================================
--- jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/interceptor/MethodFilter.java (original)
+++ jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/interceptor/MethodFilter.java Mon Aug 22 20:21:54 2005
@@ -18,6 +18,8 @@
import java.lang.reflect.Method;
/**
+ * A <code>MethodFilter</code> determines whether or not a method is accepted.
+ *
* @author James Carman
* @version 1.0
*/
Modified: jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/interceptor/MethodInterceptorChain.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/interceptor/MethodInterceptorChain.java?rev=239313&r1=239312&r2=239313&view=diff
==============================================================================
--- jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/interceptor/MethodInterceptorChain.java (original)
+++ jakarta/commons/sandbox/proxy/trunk/src/java/org/apache/commons/proxy/interceptor/MethodInterceptorChain.java Mon Aug 22 20:21:54 2005
@@ -20,6 +20,9 @@
import org.apache.commons.proxy.ObjectProvider;
/**
+ * A <code>MethodInterceptorChain</code> assists with creating proxies which go through
+ * a series of <code>MethodInterceptors</code>.
+ *
* @author James Carman
* @version 1.0
*/
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org