org.apache.tapestry5.ioc
Interface Invocation

All Known Implementing Classes:

AbstractInvocation

public interface Invocation

A method invocation passed to a MethodAdvice.

Method Summary

java.lang.String	getMethodName() Returns the name of the method being invoked.
java.lang.Object	getParameter(int index) Returns the indicated parameter (may return null if the parameter is null).
int	getParameterCount() Returns the number of parameters passed to the method.
java.lang.Class	getParameterType(int index) Returns the type of the parameter at the index.
java.lang.Object	getResult() The return value after proceed(), which may be null.
java.lang.Class	getResultType() Returns the type of the method result, which may be a primitive type (i.e., int.class) or even void (void.class).
<T extends java.lang.Throwable> T	getThrown(java.lang.Class<T> throwableClass) After invoking proceed(), used to obtain the thrown (checked) exception, if assignable to the provided type.
boolean	isFail() If true, then the proceeded invocation threw a checked exception.
void	override(int index, java.lang.Object newParameter) Replaces a parameter in the invocation.
void	overrideResult(java.lang.Object newResult) Overrides the result.
void	overrideThrown(java.lang.Exception thrown) Overrides the thrown exception.
void	proceed() Proceed with the invocation of the advised method.
void	rethrow() If the invocation failed (with a checked exception), then rethrow the exception wrapped in a RuntimeException.

Method Detail

getMethodName

java.lang.String getMethodName()

Returns the name of the method being invoked.

getResultType

java.lang.Class getResultType()

Returns the type of the method result, which may be a primitive type (i.e., int.class) or even void (void.class).

getParameterCount

int getParameterCount()

Returns the number of parameters passed to the method.

getParameterType

java.lang.Class getParameterType(int index)

Returns the type of the parameter at the index.

getParameter

java.lang.Object getParameter(int index)

Returns the indicated parameter (may return null if the parameter is null).

override

void override(int index,
              java.lang.Object newParameter)

Replaces a parameter in the invocation.

Parameters:

index - of parameter to update

newParameter - new parameter value (may be null)

proceed

void proceed()

Proceed with the invocation of the advised method. If the invocation results in a runtime exception, that is thrown. A checked exception is detected by invoking isFail().

isFail

boolean isFail()

If true, then the proceeded invocation threw a checked exception.

rethrow

void rethrow()

If the invocation failed (with a checked exception), then rethrow the exception wrapped in a RuntimeException.

Since:

5.2.0

getThrown

<T extends java.lang.Throwable> T getThrown(java.lang.Class<T> throwableClass)

After invoking proceed(), used to obtain the thrown (checked) exception, if assignable to the provided type.

Parameters:

throwableClass - the type of exception to match

Returns:

the exception, if the proceeded invocation threw a checked exception, and the exception is assignable to the provided type. In other cases, null is returned.

overrideThrown

void overrideThrown(java.lang.Exception thrown)

Overrides the thrown exception. The passed exception should be a checked exception of the method. Note that for runtime exceptions, or even Errors, those can just be thrown. Sets the fail flag.

Parameters:

thrown -

Throws:

java.lang.IllegalArgumentException - if thrown is null, or not a declared exception of the method

getResult

java.lang.Object getResult()

The return value after proceed(), which may be null.

overrideResult

void overrideResult(java.lang.Object newResult)

Overrides the result. Clears the thrown exception (if any).