AbstractRequestContext (GWT 2.7.0)

java.lang.Object
- com.google.web.bindery.requestfactory.shared.impl.AbstractRequestContext

All Implemented Interfaces:: EntityCodex.EntitySource, RequestContext

public abstract class AbstractRequestContext
extends Object
implements RequestContext, EntityCodex.EntitySource

Base implementations for RequestContext services.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AbstractRequestContext.Dialect` Allows the payload dialect to be injected into the AbstractRequestContext without the caller needing to be concerned with how the implementation object is instantiated.
`protected static class`	`AbstractRequestContext.State` Encapsulates all state contained by the AbstractRequestContext.

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractRequestContext(AbstractRequestFactory factory, AbstractRequestContext.Dialect dialect)

Constructors
Modifier	Constructor and Description
`protected`	`AbstractRequestContext(AbstractRequestFactory factory, AbstractRequestContext.Dialect dialect)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`addInvocation(AbstractRequest<?,?> request)` Called by generated subclasses to enqueue a method invocation.
`<T extends RequestContext> T`	`append(T other)` Joins another RequestContext to this RequestContext.
`<T extends BaseProxy> T`	`create(Class<T> clazz)` Create a new object, with an ephemeral id.
`protected <T extends BaseProxy> AutoBean<T>`	`createProxy(Class<T> clazz, SimpleProxyId<T> id, boolean useAppendedContexts)` Creates a new proxy with an assigned ID.
`<T extends BaseProxy> T`	`edit(T object)` Returns a mutable version of the proxy, whose mutations will accumulate in this context.
`<T extends BaseProxy> T`	`editProxy(T object)` Take ownership of a proxy instance and make it editable.
`protected void`	`fail(Receiver<Void> receiver, ServerFailure failure)` Invoke the appropriate `onFailure` callbacks, possibly throwing an `UmbrellaException` if one or more callbacks fails.
`<P extends EntityProxy> Request<P>`	`find(EntityProxyId<P> proxyId)` Return a request to find a fresh instance of the referenced proxy.
`void`	`fire()` Make sure there's a default receiver so errors don't get dropped.
`void`	`fire(Receiver<Void> receiver)` For receiving errors or validation failures only.
`protected abstract AutoBeanFactory`	`getAutoBeanFactory()` Returns an AutoBeanFactory that can produce the types reachable only from this RequestContext.
`<Q extends BaseProxy> AutoBean<Q>`	`getBeanForPayload(Splittable serializedProxyId)` EntityCodex support.
`AbstractRequestFactory`	`getRequestFactory()` Returns the `RequestFactory` that created the RequestContext.
`Splittable`	`getSerializedProxyId(SimpleProxyId<?> stableId)` EntityCodex support.
`boolean`	`isChanged()` Returns true if any changes have been made to proxies mutable under this context.
`boolean`	`isEntityType(Class<?> clazz)` EntityCodex support.
`boolean`	`isLocked()`
`boolean`	`isValueType(Class<?> clazz)` EntityCodex support.
`void`	`setFireDisabled(boolean disabled)`
`protected void`	`violation(Receiver<Void> receiver, Set<javax.validation.ConstraintViolation<?>> errors)` Invoke the appropriate `onViolation` callbacks, possibly throwing an `UmbrellaException` if one or more callbacks fails.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, toString

- Constructor Detail
  - AbstractRequestContext
```
protected AbstractRequestContext(AbstractRequestFactory factory,
                      AbstractRequestContext.Dialect dialect)
```
- Method Detail
  - append
```
public <T extends RequestContext> T append(T other)
```
    Description copied from interface: RequestContext
    Joins another RequestContext to this RequestContext.
```
 SomeContext ctx = myFactory.someContext();
 // Perform operations on ctx
 OtherContext other = ctx.append(myFactory.otherContext());
 // Perform operations on both other and ctx
 ctx.fire() // or other.fire() are equivalent 
 
```
    Specified by:
    
    append in interface RequestContext
    
    Parameters:
    other - a freshly-constructed RequestContext whose state should be bound to this RequestContext
    
    Returns:
    other
  - create
```
public <T extends BaseProxy> T create(Class<T> clazz)
```
    Create a new object, with an ephemeral id.
    
    Specified by:
    
    create in interface RequestContext
    
    Parameters:
    clazz - a Class object of type T
    
    Returns:
    an BaseProxy instance of type T
  - edit
```
public <T extends BaseProxy> T edit(T object)
```
    Description copied from interface: RequestContext
    
    Returns a mutable version of the proxy, whose mutations will accumulate in this context. Proxies reached via getters on this mutable proxy will also be mutable.
    
    Specified by:
    
    edit in interface RequestContext
    
    Parameters:
    object - an instance of type T
    
    Returns:
    an EntityProxy or ValueProxy instance of type T
  - editProxy
```
public <T extends BaseProxy> T editProxy(T object)
```
    Take ownership of a proxy instance and make it editable.
  - find
```
public <P extends EntityProxy> Request<P> find(EntityProxyId<P> proxyId)
```
    Description copied from interface: RequestContext
    
    Return a request to find a fresh instance of the referenced proxy.
    
    Specified by:
    
    find in interface RequestContext
    
    Parameters:
    proxyId - an EntityProxyId instance of type P
    
    Returns:
    a Request object
  - fire
```
public void fire()
```
    Make sure there's a default receiver so errors don't get dropped. This behavior should be revisited when chaining is supported, depending on whether or not chained invocations can fail independently.
    
    Specified by:
    
    fire in interface RequestContext
  - fire
```
public void fire(Receiver<Void> receiver)
```
    Description copied from interface: RequestContext
    
    For receiving errors or validation failures only.
    
    Specified by:
    
    fire in interface RequestContext
    
    Parameters:
    receiver - a Receiver instance
  - getBeanForPayload
```
public <Q extends BaseProxy> AutoBean<Q> getBeanForPayload(Splittable serializedProxyId)
```
    EntityCodex support.
    
    Specified by:
    
    getBeanForPayload in interface EntityCodex.EntitySource
  - getRequestFactory
```
public AbstractRequestFactory getRequestFactory()
```
    Description copied from interface: RequestContext
    
    Returns the RequestFactory that created the RequestContext.
    
    Specified by:
    
    getRequestFactory in interface RequestContext
  - getSerializedProxyId
```
public Splittable getSerializedProxyId(SimpleProxyId<?> stableId)
```
    EntityCodex support.
    
    Specified by:
    
    getSerializedProxyId in interface EntityCodex.EntitySource
  - isChanged
```
public boolean isChanged()
```
    Description copied from interface: RequestContext
    Returns true if any changes have been made to proxies mutable under this context. Note that vacuous changes — e.g. foo.setName(foo.getName() — will not trip the changed flag. Similarly, "unmaking" a change will clear the isChanged flag
```
 String name = bar.getName();
 bar.setName("something else");
 assertTrue(context.isChanged());
 bar.setName(name);
 assertFalse(context.isChanged());
 
```
    Specified by:
    
    isChanged in interface RequestContext
    
    Returns:
    true if any changes have been made
  - isEntityType
```
public boolean isEntityType(Class<?> clazz)
```
    EntityCodex support.
    
    Specified by:
    
    isEntityType in interface EntityCodex.EntitySource
  - isLocked
```
public boolean isLocked()
```
  - isValueType
```
public boolean isValueType(Class<?> clazz)
```
    EntityCodex support.
    
    Specified by:
    
    isValueType in interface EntityCodex.EntitySource
  - setFireDisabled
```
public void setFireDisabled(boolean disabled)
```
  - addInvocation
```
protected void addInvocation(AbstractRequest<?,?> request)
```
    Called by generated subclasses to enqueue a method invocation.
  - createProxy
```
protected <T extends BaseProxy> AutoBean<T> createProxy(Class<T> clazz,
                                            SimpleProxyId<T> id,
                                            boolean useAppendedContexts)
```
    Creates a new proxy with an assigned ID.
    
    Parameters:
    clazz - The proxy type
    id - The id to be assigned to the new proxy
    useAppendedContexts - if true use the AutoBeanFactory types associated with any contexts that have been passed into append(RequestContext). If false, this method will only create proxy types reachable from the implemented RequestContext interface.
    
    Throws:
    
    IllegalArgumentException - if the requested proxy type cannot be created
  - fail
```
protected void fail(Receiver<Void> receiver,
        ServerFailure failure)
```
    Invoke the appropriate onFailure callbacks, possibly throwing an UmbrellaException if one or more callbacks fails.
  - getAutoBeanFactory
```
protected abstract AutoBeanFactory getAutoBeanFactory()
```
    Returns an AutoBeanFactory that can produce the types reachable only from this RequestContext.
  - violation
```
protected void violation(Receiver<Void> receiver,
             Set<javax.validation.ConstraintViolation<?>> errors)
```
    Invoke the appropriate onViolation callbacks, possibly throwing an UmbrellaException if one or more callbacks fails.

Class AbstractRequestContext

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractRequestContext

Method Detail

append

create

edit

editProxy

find

fire

fire

getBeanForPayload

getRequestFactory

getSerializedProxyId

isChanged

isEntityType

isLocked

isValueType

setFireDisabled

addInvocation

createProxy

fail

getAutoBeanFactory

violation