no.g9.client.core.action

Interface Hookable<T>

Type Parameters:

T - The target type

All Known Implementing Classes:

ActionHook, ActionHookAdapter, CheckableHookAdapter, DisplayableHookAdapter, ObtainableHookAdapter

public interface Hookable<T>

Defines the hook methods of a g9 action. The methods defined by this interface are intended for callback from the g9 action classes. An action has a sequence of states (or phases) which translate to the methods defined by this interface.

Method Summary

Modifier and Type	Method and Description
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.
void	initialized() The initialized hook.
void	performed(T result) The performed hook, invoked after initialized() unless the action has failed or the action is canceled.
void	succeeded() The succeeded hook, invoked after performed(Object) unless the action failed or the action was canceled.

Method Detail

initialized

@ThreadInfo(value=WORKER)
void initialized()

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

@ThreadInfo(value=WORKER)
void performed(T result)

The performed hook, invoked after 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

@ThreadInfo(value=WORKER)
void succeeded()

The succeeded hook, invoked after 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

@ThreadInfo(value=WORKER)
Message failed(Throwable cause,
                                         Message message)

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

@ThreadInfo(value=WORKER)
void cancelled()

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

@ThreadInfo(value=WORKER)
void finished()

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.