griffon.core.controller

Interface ActionHandler

All Known Implementing Classes:

AbstractActionHandler

public interface ActionHandler

Since:

2.1.0

Author:

Andres Almiray

Field Summary

Fields

Modifier and Type	Field and Description
static String	SUFFIX

Method Summary

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

Field Detail

SUFFIX

static final String SUFFIX

See Also:

Constant Field Values

Method Detail

update

void update(@Nonnull
            Action action)

Update the action's properties.

Parameters:

action - the action to be updated

configure

void configure(@Nonnull
               Action action,
               @Nonnull
               Method method)

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().

Parameters:

action - the action to be configured

method - the method that represents the action itself

before

@Nonnull
Object[] before(@Nonnull
                         Action action,
                         @Nonnull
                         Object[] args)

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.

Parameters:

action - the action to execute

args - the action's arguments

Returns:

arguments to be sent to the action

Throws:

AbortActionExecution - if action execution should be aborted.

after

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

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

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

boolean exception(@Nonnull
                  Exception exception,
                  @Nonnull
                  Action action,
                  @Nonnull
                  Object[] args)

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.

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.