com.google.gwt.resources.rebind.context

Class AbstractResourceContext

java.lang.Object

com.google.gwt.resources.rebind.context.AbstractResourceContext

All Implemented Interfaces:

ResourceContext

Direct Known Subclasses:

MhtmlResourceContext

public abstract class AbstractResourceContext
extends Object
implements ResourceContext

Defines base methods for ResourceContext implementations.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	MAX_INLINE_SIZE The largest file size that will be inlined.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractResourceContext(com.google.gwt.core.ext.TreeLogger logger, com.google.gwt.core.ext.GeneratorContext context, com.google.gwt.core.ext.typeinfo.JClassType resourceBundleType, ClientBundleContext clientBundleCtx)

Method Summary

Methods

Modifier and Type	Method and Description
String	deploy(URL resource, boolean forceExternal) Deprecated.
String	deploy(URL resource, String mimeType, boolean forceExternal) Cause a specific collection of bytes to be available in the program's compiled output.
<T> T	getCachedData(String key, Class<T> clazz) Retrieve data from the ResourceContext.
com.google.gwt.core.ext.typeinfo.JClassType	getClientBundleType() Return the interface type of the resource bundle being generated.
protected com.google.gwt.core.ext.GeneratorContext	getContext()
com.google.gwt.core.ext.GeneratorContext	getGeneratorContext() Return the GeneratorContext in which the overall resource generation framework is being run.
String	getImplementationSimpleSourceName() Returns the simple source name of the implementation of the bundle being generated.
protected com.google.gwt.core.ext.TreeLogger	getLogger()
ClientBundleRequirements	getRequirements() Returns a ClientBundleRequirements object, which can be used to track deferred-binding and configuration properties that are relevant to a resource context.
<T> boolean	putCachedData(String key, T value) Store data in the ResourceContext.
void	setRequirements(ClientBundleRequirements requirements)
protected static String	toBase64(byte[] data)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, toString

Methods inherited from interface com.google.gwt.resources.ext.ResourceContext

deploy, supportsDataUrls

Field Detail

MAX_INLINE_SIZE

protected static final int MAX_INLINE_SIZE

The largest file size that will be inlined. Note that this value is taken before any encodings are applied.

See Also:

Constant Field Values

Constructor Detail

AbstractResourceContext

protected AbstractResourceContext(com.google.gwt.core.ext.TreeLogger logger,
                       com.google.gwt.core.ext.GeneratorContext context,
                       com.google.gwt.core.ext.typeinfo.JClassType resourceBundleType,
                       ClientBundleContext clientBundleCtx)

Method Detail

toBase64

protected static String toBase64(byte[] data)

deploy

@Deprecated
public String deploy(URL resource,
                       boolean forceExternal)
              throws com.google.gwt.core.ext.UnableToCompleteException

Deprecated.

Description copied from interface: ResourceContext

Cause a specific collection of bytes to be available in the program's compiled output. The return value of this method is a Java expression which will evaluate to the location of the resource at runtime. The exact format should not be depended upon.

Specified by:

deploy in interface ResourceContext

Parameters:

resource - the resource to add to the compiled output

forceExternal - prevents embedding of the resource, e.g. in case of known incompatibilities or for example to enforce compatibility with security restrictions if the resource is intended to be accessed via an XMLHttpRequest

Returns:

a Java expression which will evaluate to the location of the provided resource at runtime

Throws:

com.google.gwt.core.ext.UnableToCompleteException

deploy

public String deploy(URL resource,
            String mimeType,
            boolean forceExternal)
              throws com.google.gwt.core.ext.UnableToCompleteException

Description copied from interface: ResourceContext

Cause a specific collection of bytes to be available in the program's compiled output. The return value of this method is a Java expression which will evaluate to the location of the resource at runtime. The exact format should not be depended upon.

Specified by:

deploy in interface ResourceContext

Parameters:

resource - the resource to add to the compiled output

mimeType - optional MIME Type to be used for an embedded resource

forceExternal - prevents embedding of the resource, e.g. in case of known incompatibilities or for example to enforce compatibility with security restrictions if the resource is intended to be accessed via an XMLHttpRequest

Returns:

a Java expression which will evaluate to the location of the provided resource at runtime

Throws:

com.google.gwt.core.ext.UnableToCompleteException

getCachedData

public <T> T getCachedData(String key,
                  Class<T> clazz)

Description copied from interface: ResourceContext

Retrieve data from the ResourceContext.

Specified by:

getCachedData in interface ResourceContext

Type Parameters:

T - the type of data to retrieve

Parameters:

key - the key value passed to ResourceContext.getCachedData(java.lang.String, java.lang.Class<T>)

clazz - the type to which the cached value must be assignable

Returns:

the value previously passed to ResourceContext.putCachedData(java.lang.String, T) or null if the data was not found

getClientBundleType

public com.google.gwt.core.ext.typeinfo.JClassType getClientBundleType()

Description copied from interface: ResourceContext

Return the interface type of the resource bundle being generated.

Specified by:

getClientBundleType in interface ResourceContext

getGeneratorContext

public com.google.gwt.core.ext.GeneratorContext getGeneratorContext()

Description copied from interface: ResourceContext

Return the GeneratorContext in which the overall resource generation framework is being run. Implementations of ResourceGenerator should prefer ResourceContext.deploy(java.lang.String, java.lang.String, byte[], boolean) over GeneratorContext.tryCreateResource(com.google.gwt.core.ext.TreeLogger, java.lang.String) in order to take advantage of serving optimizations that can be performed by the bundle architecture.

Specified by:

getGeneratorContext in interface ResourceContext

getImplementationSimpleSourceName

public String getImplementationSimpleSourceName()

Description copied from interface: ResourceContext

Returns the simple source name of the implementation of the bundle being generated. This can be used during code-generation to refer to the instance of the bundle (e.g. via SimpleSourceName.this).

Specified by:

getImplementationSimpleSourceName in interface ResourceContext

getRequirements

public ClientBundleRequirements getRequirements()

Description copied from interface: ResourceContext

Returns a ClientBundleRequirements object, which can be used to track deferred-binding and configuration properties that are relevant to a resource context.

Specified by:

getRequirements in interface ResourceContext

putCachedData

public <T> boolean putCachedData(String key,
                        T value)

Description copied from interface: ResourceContext

Store data in the ResourceContext. ResourceGenerators may reduce the amount of recomputation performed by caching data the ResourceContext. This cache will be invalidated when the compiler's TypeOracle is refreshed or replaced. Each ResourceGenerator has an isolated view of the cache.

Specified by:

putCachedData in interface ResourceContext

Type Parameters:

T - the type of data being stored

Parameters:

key - a string key to locate the data

value - the value to store

Returns:

true if the cache did not previously contain the key-value pair

setRequirements

public void setRequirements(ClientBundleRequirements requirements)

getContext

protected com.google.gwt.core.ext.GeneratorContext getContext()

getLogger

protected com.google.gwt.core.ext.TreeLogger getLogger()