com.gwtplatform.dispatch.client.actionhandler.caching

Class ActionCachingHandler<A,R>

java.lang.Object

com.gwtplatform.dispatch.client.actionhandler.AbstractClientActionHandler<A,R>

com.gwtplatform.dispatch.client.actionhandler.caching.AbstractCachingClientActionHandler<A,R>

com.gwtplatform.dispatch.client.actionhandler.caching.ActionCachingHandler<A,R>

Type Parameters:

A - The type of the action.

R - The type of the result.

All Implemented Interfaces:

ClientActionHandler<A,R>

public class ActionCachingHandler<A,R>
extends AbstractCachingClientActionHandler<A,R>

Default implementation of AbstractCachingClientActionHandler. It supports action caching

Constructor Summary

Constructors

Constructor and Description
ActionCachingHandler(Class<A> actionType, Cache cache)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	postfetch(A action, R result) Override this method to perform an action after the call to the server returns successfully or not.
protected R	prefetch(A action) Override this method to perform an action before the call is sent to the server.

Methods inherited from class com.gwtplatform.dispatch.client.actionhandler.caching.AbstractCachingClientActionHandler

execute, getCache, undo

Methods inherited from class com.gwtplatform.dispatch.client.actionhandler.AbstractClientActionHandler

getActionType

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionCachingHandler

public ActionCachingHandler(Class<A> actionType,
                    Cache cache)

Method Detail

postfetch

protected void postfetch(A action,
             R result)

Description copied from class: AbstractCachingClientActionHandler

Override this method to perform an action after the call to the server returns successfully or not. If the call succeeded, the result will be passed, if it failed null will be passed in the result parameter.

You can use this method to add the result to cache, if it is null you should remove the action from the cache.

Specified by:

postfetch in class AbstractCachingClientActionHandler<A,R>

Parameters:

action - The action that just finished execution on the server.

result - The result after the server call, or null if the server call failed.

prefetch

protected R prefetch(A action)

Description copied from class: AbstractCachingClientActionHandler

Override this method to perform an action before the call is sent to the server. If the call returns a non-null result then the action is never executed on the server and the returned value is used. If the call returns null then the action is executed on the server.

You can use this method to fetch the action from the cache.

Specified by:

prefetch in class AbstractCachingClientActionHandler<A,R>

Parameters:

action - The action to be prefetched

Returns:

The prefetched result. If not found, return null.