no.g9.client.core.action

Class ActionHookAdapter<T>

java.lang.Object

no.g9.client.core.action.ActionHook<T>

no.g9.client.core.action.ActionHookAdapter<T>

Type Parameters:

T - The action target type

All Implemented Interfaces:

Hookable<T>

Direct Known Subclasses:

CheckableHookAdapter

public abstract class ActionHookAdapter<T>
extends ActionHook<T>

The action hook adapter offers an empty implementation of the basic hook methods. Application programmers should extend this adapter (or one of it's sub-classes) and override the hook methods they are interested in.

Constructor Summary

Constructors

Constructor and Description
ActionHookAdapter()

Method Summary

Modifier and Type	Method and Description
protected void	cancelAction() Cancel the ongoing action.
void	cancelled() The canceled hook, invoked if the action is canceled before or during the execution of the action.
Message	failed(Throwable cause, Message message) The failed hook, invoked if an exception is raised during the execution of the action.
void	finished() This finished hook, unconditionally invoked as the last method in an action life cycle.
protected ApplicationController	getApplicationController() Get the application controller of the ongoing action, or null if there is no current, ongoing action.
void	initialized() The initialized hook.
void	performed(T result) The performed hook, invoked after Hookable.initialized() unless the action has failed or the action is canceled.
void	succeeded() The succeeded hook, invoked after Hookable.performed(Object) unless the action failed or the action was canceled.

Methods inherited from class no.g9.client.core.action.ActionHook

getCurrentAction, getEvent, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionHookAdapter

public ActionHookAdapter()

Method Detail

cancelAction

protected void cancelAction()

Cancel the ongoing action.

Throws:

IllegalStateException - if the action cannot be cancelled.

See Also:

G9Action.cancel()

getApplicationController

protected final ApplicationController getApplicationController()

Get the application controller of the ongoing action, or null if there is no current, ongoing action.

Returns:

the application controller.

initialized

public void initialized()

Description copied from interface: Hookable

The initialized hook. This hook is invoked immediately before the action is started.

If applicable, this hook is invoked on a dedicated worker thread by default. Use the annotation ThreadInfo to control which thread this method is invoked on.

performed

public void performed(T result)

Description copied from interface: Hookable

The performed hook, invoked after Hookable.initialized() unless the action has failed or the action is canceled.

If applicable, this hook is invoked on a dedicated worker thread by default. Use the annotation ThreadInfo to control which thread this method is invoked on.

Parameters:

result - The result of invoking the action

succeeded

public void succeeded()

Description copied from interface: Hookable

The succeeded hook, invoked after Hookable.performed(Object) unless the action failed or the action was canceled.

If applicable, this hook is invoked on a dedicated worker thread by default. Use the annotation ThreadInfo to control which thread this method is invoked on.

failed

public Message failed(Throwable cause,
                      Message message)

Description copied from interface: Hookable

The failed hook, invoked if an exception is raised during the execution of the action.

The returned message will be displayed to the user (null means no display).

If applicable, this hook is invoked on a dedicated worker thread by default. Use the annotation ThreadInfo to control which thread this method is invoked on.

Parameters:

cause - The throwable that caused the execution of the action to abort

message - The message object from a previously executed failed hook, or null

Returns:

The message that should be displayed in order to inform the user about the failure

cancelled

public void cancelled()

Description copied from interface: Hookable

The canceled hook, invoked if the action is canceled before or during the execution of the action.

If applicable, this hook is invoked on a dedicated worker thread by default. Use the annotation ThreadInfo to control which thread this method is invoked on.

finished

public void finished()

Description copied from interface: Hookable

This finished hook, unconditionally invoked as the last method in an action life cycle.

If applicable, this hook is invoked on a dedicated worker thread by default. Use the annotation ThreadInfo to control which thread this method is invoked on.