org.codehaus.griffon.runtime.core.controller

Class AbstractActionHandler

java.lang.Object

org.codehaus.griffon.runtime.core.controller.AbstractActionHandler

All Implemented Interfaces:

ActionHandler

public class AbstractActionHandler
extends java.lang.Object
implements ActionHandler

Since:

2.1.0

Author:

Andres Almiray

Field Summary

Fields inherited from interface griffon.core.controller.ActionHandler

SUFFIX

Constructor Summary

Constructors

Constructor and Description
AbstractActionHandler()

Method Summary

Modifier and Type	Method and Description
protected AbortActionExecution	abortActionExecution()
java.lang.Object	after(ActionExecutionStatus status, Action action, java.lang.Object[] args, java.lang.Object result) Called after the action has been aborted or executed, even if an exception occurred during execution.
java.lang.Object[]	before(Action action, java.lang.Object[] args) Called before an action is executed.
void	configure(Action action, java.lang.reflect.Method method) Inspect the action during the configuration phase.
boolean	exception(java.lang.Exception exception, Action action, java.lang.Object[] args) Called after the action has been executed when an exception occurred during execution.
void	update(Action action) Update the action's properties.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractActionHandler

public AbstractActionHandler()

Method Detail

update

public void update(@Nonnull
                   Action action)

Description copied from interface: ActionHandler

Update the action's properties.

Specified by:

update in interface ActionHandler

Parameters:

action - the action to be updated

configure

public void configure(@Nonnull
                      Action action,
                      @Nonnull
                      java.lang.reflect.Method method)

Description copied from interface: ActionHandler

Inspect the action during the configuration phase.

This is the perfect time to search for annotations or any other information required by the action. handlers have the option to cache such inspections and recall them during before(), after() and exception().

Specified by:

configure in interface ActionHandler

Parameters:

action - the action to be configured

method - the method that represents the action itself

before

@Nonnull
public java.lang.Object[] before(@Nonnull
                                          Action action,
                                          @Nonnull
                                          java.lang.Object[] args)

Description copied from interface: ActionHandler

Called before an action is executed.

Implementors have the choice of throwing an AbortActionExecution in order to signal that the action should not be invoked. In any case this method returns the arguments to be sent to the action, thus allowing the interceptor to modify the arguments as it deem necessary. Failure to return an appropriate value will most likely cause an error during the action's execution.

Specified by:

before in interface ActionHandler

Parameters:

action - the action to execute

args - the action's arguments

Returns:

arguments to be sent to the action

after

@Nullable
public java.lang.Object after(@Nonnull
                                        ActionExecutionStatus status,
                                        @Nonnull
                                        Action action,
                                        @Nonnull
                                        java.lang.Object[] args,
                                        @Nullable
                                        java.lang.Object result)

Description copied from interface: ActionHandler

Called after the action has been aborted or executed, even if an exception occurred during execution.

Specified by:

after in interface ActionHandler

Parameters:

status - a flag that indicates the execution status of the action

action - the action to execute

args - the arguments sent to the action

result - the result of executing the action

exception

public boolean exception(@Nonnull
                         java.lang.Exception exception,
                         @Nonnull
                         Action action,
                         @Nonnull
                         java.lang.Object[] args)

Description copied from interface: ActionHandler

Called after the action has been executed when an exception occurred during execution.

The exception will be rethrown by the ActionManager if is not handled by any interceptor.

Specified by:

exception in interface ActionHandler

Parameters:

exception - the exception thrown during the action's execution

action - the action to execute

args - the arguments sent to the action during execution

Returns:

true if the exception was handled successfully, false otherwise.

abortActionExecution

@Nonnull
protected AbortActionExecution abortActionExecution()
                                                      throws AbortActionExecution

Throws:

AbortActionExecution