com.google.web.bindery.requestfactory.shared.impl

Class AbstractRequestFactory

java.lang.Object

com.google.web.bindery.requestfactory.shared.impl.IdFactory

com.google.web.bindery.requestfactory.shared.impl.AbstractRequestFactory

All Implemented Interfaces:

RequestFactory

Direct Known Subclasses:

AbstractClientRequestFactory

public abstract class AbstractRequestFactory
extends IdFactory
implements RequestFactory

Base type for generated RF interfaces.

Field Summary

Fields inherited from interface com.google.web.bindery.requestfactory.shared.RequestFactory

JSON_CONTENT_TYPE_UTF8

Constructor Summary

Constructors

Constructor and Description
AbstractRequestFactory()

Method Summary

Methods

Modifier and Type	Method and Description
<P extends EntityProxy> Request<P>	find(EntityProxyId<P> proxyId) Return a request to find a fresh instance of the referenced proxy.
protected abstract AutoBeanFactory	getAutoBeanFactory() Implementations of EntityProxies are provided by an AutoBeanFactory, which is itself a generated type.
EventBus	getEventBus() Returns the event bus this factory's events are posted on, which was set via RequestFactory.initialize(com.google.web.bindery.event.shared.EventBus).
abstract String	getFactoryTypeToken() Returns a type token for the RequestFactory instance, which is used to seed operation and type token resolution on the server.
String	getHistoryToken(Class<? extends EntityProxy> clazz) Get a History compatible token that represents the given class.
String	getHistoryToken(EntityProxyId<?> proxy) Get a History compatible token that represents the given proxy class.
Class<? extends EntityProxy>	getProxyClass(String historyToken) Return the class object which may be used to create new instances of the type of this token, via RequestContext.create(java.lang.Class<T>).
<T extends EntityProxy> EntityProxyId<T>	getProxyId(String historyToken) Return the appropriate EntityProxyId using a string returned from RequestFactory.getHistoryToken(EntityProxyId).
RequestTransport	getRequestTransport() Returns the RequestTransport set via RequestFactory.initialize(com.google.web.bindery.event.shared.EventBus).
ProxySerializer	getSerializer(ProxyStore store) Returns a ProxySerializer that can encode and decode the various EntityProxy and ValueProxy types reachable from the RequestFactory.
protected boolean	hasVersionChanged(SimpleProxyId<?> id, String observedVersion) Used by AbstractRequestContext to quiesce update events for objects that haven't truly changed.
abstract void	initialize(EventBus eventBus) The choice of a default request transport is runtime-specific.
void	initialize(EventBus eventBus, RequestTransport transport) Start this request factory with a user-provided transport.

Methods inherited from class com.google.web.bindery.requestfactory.shared.impl.IdFactory

allocateId, allocateSyntheticId, asEntityProxy, asValueProxy, getBaseProxyId, getHistoryToken, getId, getId, getId, getTypeFromToken, getTypeToken, isEntityType, isValueType

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, toString

Constructor Detail

AbstractRequestFactory

public AbstractRequestFactory()

Method Detail

find

public <P extends EntityProxy> Request<P> find(EntityProxyId<P> proxyId)

Description copied from interface: RequestFactory

Return a request to find a fresh instance of the referenced proxy. If it is necessary to load several proxy instances, use RequestContext.find(EntityProxyId), which supports chained requests.

Specified by:

find in interface RequestFactory

Parameters:

proxyId - an EntityProxyId instance of type P

Returns:

a Request object

See Also:

RequestContext.find(EntityProxyId)

getEventBus

public EventBus getEventBus()

Description copied from interface: RequestFactory

Returns the event bus this factory's events are posted on, which was set via RequestFactory.initialize(com.google.web.bindery.event.shared.EventBus).

Specified by:

getEventBus in interface RequestFactory

Returns:

the EventBus associated with this instance

getFactoryTypeToken

public abstract String getFactoryTypeToken()

Returns a type token for the RequestFactory instance, which is used to seed operation and type token resolution on the server.

getHistoryToken

public String getHistoryToken(Class<? extends EntityProxy> clazz)

Description copied from interface: RequestFactory

Get a History compatible token that represents the given class. It can be processed by RequestFactory.getProxyClass(String)

Specified by:

getHistoryToken in interface RequestFactory

Parameters:

clazz - a Class object for an EntityProxy subclass

Returns:

a History compatible token

getHistoryToken

public String getHistoryToken(EntityProxyId<?> proxy)

Description copied from interface: RequestFactory

Get a History compatible token that represents the given proxy class. It can be processed by RequestFactory.getProxyClass(String).

The history token returned for an EntityProxyId associated with a newly-created (future) EntityProxy will differ from the token returned by this method after the EntityProxy has been persisted. Once an EntityProxy has been persisted, the return value for this method will always be stable, regardless of when the EntityProxyId was retrieved relative to the persist operation. In other words, the "future" history token returned for an as-yet-unpersisted EntityProxy is only valid for the duration of the RequestFactory's lifespan.

Specified by:

getHistoryToken in interface RequestFactory

Parameters:

proxy - an EntityProxyId instance

Returns:

a History compatible token

getProxyClass

public Class<? extends EntityProxy> getProxyClass(String historyToken)

Description copied from interface: RequestFactory

Return the class object which may be used to create new instances of the type of this token, via RequestContext.create(java.lang.Class<T>). The token may represent either a proxy instance (see RequestFactory.getHistoryToken(java.lang.Class<? extends com.google.web.bindery.requestfactory.shared.EntityProxy>)) or a proxy class (see RequestFactory.getProxyClass(java.lang.String)).

Specified by:

getProxyClass in interface RequestFactory

Parameters:

historyToken - a String token

Returns:

a Class object for an EntityProxy subclass

getProxyId

public <T extends EntityProxy> EntityProxyId<T> getProxyId(String historyToken)

Description copied from interface: RequestFactory

Return the appropriate EntityProxyId using a string returned from RequestFactory.getHistoryToken(EntityProxyId).

Specified by:

getProxyId in interface RequestFactory

Parameters:

historyToken - a String token

Returns:

an EntityProxyId

getRequestTransport

public RequestTransport getRequestTransport()

Description copied from interface: RequestFactory

Returns the RequestTransport set via RequestFactory.initialize(com.google.web.bindery.event.shared.EventBus).

Specified by:

getRequestTransport in interface RequestFactory

Returns:

the RequestTransport associated with this instance

getSerializer

public ProxySerializer getSerializer(ProxyStore store)

Description copied from interface: RequestFactory

Returns a ProxySerializer that can encode and decode the various EntityProxy and ValueProxy types reachable from the RequestFactory.

Specified by:

getSerializer in interface RequestFactory

Parameters:

store - a helper object for the ProxySerializer to provide low-level storage access

Returns:

a new ProxySerializer

See Also:

DefaultProxyStore

initialize

public abstract void initialize(EventBus eventBus)

The choice of a default request transport is runtime-specific.

Specified by:

initialize in interface RequestFactory

Parameters:

eventBus - an EventBus

initialize

public void initialize(EventBus eventBus,
              RequestTransport transport)

Description copied from interface: RequestFactory

Start this request factory with a user-provided transport.

Specified by:

initialize in interface RequestFactory

Parameters:

eventBus - an EventBus

transport - a RequestTransport instance

getAutoBeanFactory

protected abstract AutoBeanFactory getAutoBeanFactory()

Implementations of EntityProxies are provided by an AutoBeanFactory, which is itself a generated type. This method knows about all proxy types used in the RequestFactory interface, which prevents pruning of any proxy type. If the find(EntityProxyId) and getSerializer(ProxyStore) were provided by AbstractRequestContext, this method could be removed.

hasVersionChanged

protected boolean hasVersionChanged(SimpleProxyId<?> id,
                        String observedVersion)

Used by AbstractRequestContext to quiesce update events for objects that haven't truly changed.