xapi.dev.generators

Class AbstractInjectionGenerator

java.lang.Object

com.google.gwt.core.ext.Generator

com.google.gwt.core.ext.IncrementalGenerator

xapi.dev.generators.AbstractInjectionGenerator

Direct Known Subclasses:

AsyncInjectionGenerator, GwtDevInjectionGenerator, InstanceInjectionGenerator, RunAsyncInjectionGenerator, SyncInjectionGenerator

public abstract class AbstractInjectionGenerator
extends com.google.gwt.core.ext.IncrementalGenerator

Base class for all generators providing injected singletons.

This class is used in both gwt-dev and gwt-prod,
with static utility methods being provided to subclasses and other package-level utilities.

Important methods:
#ensureCallbackClass(TreeLogger, String, String, String, String, GeneratorContext)
- Ensures that there is an asynchronous (code splitting) provider for the injected class
ensureProviderClass(TreeLogger, String, String, String, String, GeneratorContext)
- Ensures that there is a static provider of a given singleton.

Note that if an async provider is accessed before there is a synchronous provider,
then the synchronous provider will route through the async callback method,
to prevent code splitting from being ruined.

If your code accesses the synchronous provider before the async provider,
the async provider will skip using a code split (as it wouldn't work anyway).
To override this behaviour, set SingletonOverride#forceAsync() to true

Author:

James X. Nelson (james@wetheinter.net, @james)

Constructor Summary

Constructors

Constructor and Description
AbstractInjectionGenerator()

Method Summary

Methods

Modifier and Type	Method and Description
static InjectionCallbackArtifact	ensureAsyncInjected(com.google.gwt.core.ext.TreeLogger logger, String packageName, String className, String outputClass, com.google.gwt.core.ext.GeneratorContext ctx)
static boolean	ensureProviderClass(com.google.gwt.core.ext.TreeLogger logger, String packageName, String simpleName0, String canonical, String qualifiedSourceName, com.google.gwt.core.ext.GeneratorContext ctx)
protected void	finalize()
protected static GwtInjectionMap	getInjectionMap(com.google.gwt.core.ext.TreeLogger logger, com.google.gwt.core.ext.GeneratorContext ctx)
long	getVersionId()
protected static boolean	isAsyncProvided(com.google.gwt.core.ext.TreeLogger logger, String packageName, String simpleSourceName, com.google.gwt.core.ext.GeneratorContext context)
protected static boolean	isCallbackInjected(com.google.gwt.core.ext.TreeLogger logger, String packageName, String simpleSourceName, com.google.gwt.core.ext.GeneratorContext context)
protected void	tryWriteMetaInf(com.google.gwt.core.ext.TreeLogger logger, Class<?> cls, JClassType impl, com.google.gwt.core.ext.GeneratorContext context)

Methods inherited from class com.google.gwt.core.ext.IncrementalGenerator

generate, generateIncrementally, generateNonIncrementally

Methods inherited from class com.google.gwt.core.ext.Generator

escape

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractInjectionGenerator

public AbstractInjectionGenerator()

Method Detail

getInjectionMap

protected static GwtInjectionMap getInjectionMap(com.google.gwt.core.ext.TreeLogger logger,
                              com.google.gwt.core.ext.GeneratorContext ctx)

getVersionId

public long getVersionId()

Specified by:

getVersionId in class com.google.gwt.core.ext.IncrementalGenerator

tryWriteMetaInf

protected void tryWriteMetaInf(com.google.gwt.core.ext.TreeLogger logger,
                   Class<?> cls,
                   JClassType impl,
                   com.google.gwt.core.ext.GeneratorContext context)

isAsyncProvided

protected static boolean isAsyncProvided(com.google.gwt.core.ext.TreeLogger logger,
                      String packageName,
                      String simpleSourceName,
                      com.google.gwt.core.ext.GeneratorContext context)

isCallbackInjected

protected static boolean isCallbackInjected(com.google.gwt.core.ext.TreeLogger logger,
                         String packageName,
                         String simpleSourceName,
                         com.google.gwt.core.ext.GeneratorContext context)

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

ensureAsyncInjected

public static InjectionCallbackArtifact ensureAsyncInjected(com.google.gwt.core.ext.TreeLogger logger,
                                            String packageName,
                                            String className,
                                            String outputClass,
                                            com.google.gwt.core.ext.GeneratorContext ctx)
                                                     throws com.google.gwt.core.ext.UnableToCompleteException

Throws:

com.google.gwt.core.ext.UnableToCompleteException

ensureProviderClass

public static boolean ensureProviderClass(com.google.gwt.core.ext.TreeLogger logger,
                          String packageName,
                          String simpleName0,
                          String canonical,
                          String qualifiedSourceName,
                          com.google.gwt.core.ext.GeneratorContext ctx)