com.thoughtworks.proxy.toys.echo

Class EchoDecorator

java.lang.Object

com.thoughtworks.proxy.toys.decorate.InvocationDecoratorSupport

com.thoughtworks.proxy.toys.echo.EchoDecorator

All Implemented Interfaces:

InvocationDecorator, java.io.Serializable

public class EchoDecorator
extends InvocationDecoratorSupport

A InvocationDecoratorSupport implementation that echoes any invocation to a PrintWriter.

The implementation will try to create new proxies for every return value, that can be proxied by the ProxyFactory in use.

Since:

0.1

Author:

Dan North, Jörg Schaible

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EchoDecorator(java.io.PrintWriter out, ProxyFactory factory) Construct an EchoingDecorator.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object[]	beforeMethodStarts(java.lang.Object proxy, java.lang.reflect.Method method, java.lang.Object[] args) Called before a method is invoked on an object, to possibly decorate the arguments being passed to the method invocation.
java.lang.Exception	decorateInvocationException(java.lang.Object proxy, java.lang.reflect.Method method, java.lang.Object[] args, java.lang.Exception cause) Called when a method cannot be invoked, to possibly decorate the type of error.
java.lang.Object	decorateResult(java.lang.Object proxy, java.lang.reflect.Method method, java.lang.Object[] args, java.lang.Object result) Called on the way back from a method invocation, to possibly decorate the result.
java.lang.Throwable	decorateTargetException(java.lang.Object proxy, java.lang.reflect.Method method, java.lang.Object[] args, java.lang.Throwable cause) Called when a called method fails, to possibly decorate the type of error.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EchoDecorator

public EchoDecorator(java.io.PrintWriter out,
             ProxyFactory factory)

Construct an EchoingDecorator.

Parameters:

out - the PrintWriter receving the logs

factory - the ProxyFactory to use

Since:

0.2, different arguments in 0.1

Method Detail

beforeMethodStarts

public java.lang.Object[] beforeMethodStarts(java.lang.Object proxy,
                                    java.lang.reflect.Method method,
                                    java.lang.Object[] args)

Description copied from interface: InvocationDecorator

Called before a method is invoked on an object, to possibly decorate the arguments being passed to the method invocation.

Specified by:

beforeMethodStarts in interface InvocationDecorator

Overrides:

beforeMethodStarts in class InvocationDecoratorSupport

Parameters:

proxy - the proxy the method will be invoked on

method - the method to be invoked

args - the arguments being passed to the method

Returns:

the decorated arguments (typically just the ones supplied)

decorateResult

public java.lang.Object decorateResult(java.lang.Object proxy,
                              java.lang.reflect.Method method,
                              java.lang.Object[] args,
                              java.lang.Object result)

Description copied from interface: InvocationDecorator

Called on the way back from a method invocation, to possibly decorate the result.

Specified by:

decorateResult in interface InvocationDecorator

Overrides:

decorateResult in class InvocationDecoratorSupport

Parameters:

proxy - the proxy the method was be invoked on

method - the invoked method

args - the arguments passed to the method

result - the result of the method invocation

Returns:

the decorated result (typically just the supplied result)

decorateTargetException

public java.lang.Throwable decorateTargetException(java.lang.Object proxy,
                                          java.lang.reflect.Method method,
                                          java.lang.Object[] args,
                                          java.lang.Throwable cause)

Description copied from interface: InvocationDecorator

Called when a called method fails, to possibly decorate the type of error.

Specified by:

decorateTargetException in interface InvocationDecorator

Overrides:

decorateTargetException in class InvocationDecoratorSupport

Parameters:

proxy - the proxy the method was be invoked on

method - the invoked method

args - the arguments passed to the method

cause - the original exception thrown

Returns:

the decorated exception (typically just the supplied cause)

decorateInvocationException

public java.lang.Exception decorateInvocationException(java.lang.Object proxy,
                                              java.lang.reflect.Method method,
                                              java.lang.Object[] args,
                                              java.lang.Exception cause)

Description copied from interface: InvocationDecorator

Called when a method cannot be invoked, to possibly decorate the type of error.

Specified by:

decorateInvocationException in interface InvocationDecorator

Overrides:

decorateInvocationException in class InvocationDecoratorSupport

Parameters:

proxy - the proxy the method was be invoked on

method - the invoked method

args - the arguments passed to the method

cause - the original exception thrown

Returns:

the decorated exception (typically just the supplied cause)