xapi.dev.inject

Class MagicMethods

java.lang.Object

xapi.dev.inject.MagicMethods

public class MagicMethods
extends Object

A collection of magic method providers used for gwt production mode. These methods are mapped over top of existing static methods, to allow modification / extension of GWT.create() (the original implementation is jacked directly from GWT.create() in UnifyAst). Because these methods are only used in production mode, the methods they override must implement the same functionality for gwt dev mode / pure java. It is recommended to direct your magic methods outside of the class from which they are called; the contents of the class they are sourced from will be included in production gwt compiles, so simply delegate your static methods from X_Impl.someMethod -> Jre_Impl.someMethod, and do your work there. In order to inject your own magic methods, simply include xapi.X_Inject in your gwt module, then add the following (assuming your method is: This value string is a little monsterous, but it simple maps the type signature of the method you want to replace, with the method you will use to build the AST. The type signature of your static injection methods must match the supplied signature of MagicMethodGenerator.injectMagic(TreeLogger, JMethodCall, JMethod, Context, UnifyAstView), though you may name your methods anything you please, and must return a JExpression or throw an exception. Returning null will allow your code to compile, but you will hit mysterious null.nullMethod() errors. (in other words, throw an exception instead of return null; unless you love hours of debugging.)

Author:

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

Constructor Summary

Constructors

Constructor and Description
MagicMethods()

Method Summary

Methods

Modifier and Type	Method and Description
static com.google.gwt.dev.jjs.ast.JExpression	rebindInstance(com.google.gwt.core.ext.TreeLogger logger, com.google.gwt.dev.jjs.ast.JMethodCall x, com.google.gwt.dev.jjs.ast.JMethod currentMethod, com.google.gwt.dev.jjs.ast.Context context, UnifyAstView ast) Replaces a call from X_Inject.singleton(Class) by first a-0) generating a provider which will be synchronous if an async call hasn't already been made, or a-1) generating a provider which will route through the async provider, and return null before inited.
static <T> com.google.gwt.dev.jjs.ast.JExpression	rebindNewInstance(com.google.gwt.core.ext.TreeLogger logger, com.google.gwt.dev.jjs.ast.JMethodCall x, com.google.gwt.dev.jjs.ast.JMethod currentMethod, com.google.gwt.dev.jjs.ast.Context context, UnifyAstView ast)
static com.google.gwt.dev.jjs.ast.JExpression	rebindSingleton(com.google.gwt.core.ext.TreeLogger logger, com.google.gwt.dev.jjs.ast.JMethodCall x, com.google.gwt.dev.jjs.ast.JMethod currentMethod, com.google.gwt.dev.jjs.ast.Context context, UnifyAstView ast) Replaces a call from X_Inject.singleton(Class) by first a-0) generating a provider which will be synchronous if an async call hasn't already been made, or a-1) generating a provider which will route through the async provider, and return null before inited.
static com.google.gwt.dev.jjs.ast.JExpression	rebindSingletonAndCallback(com.google.gwt.core.ext.TreeLogger logger, com.google.gwt.dev.jjs.ast.JMethodCall methodCall, com.google.gwt.dev.jjs.ast.JMethod currentMethod, com.google.gwt.dev.jjs.ast.Context context, UnifyAstView ast) Replaces a call from X_Inject.singletonAsync(Class, xapi.util.api.ReceivesValue) by first a) generating an async provider, and then b) sending the value receiver into the async provider as a callback.
static com.google.gwt.dev.jjs.ast.JExpression	rebindSingletonAsync(com.google.gwt.core.ext.TreeLogger logger, com.google.gwt.dev.jjs.ast.JMethodCall methodCall, com.google.gwt.dev.jjs.ast.JMethod currentMethod, com.google.gwt.dev.jjs.ast.Context context, UnifyAstView ast) Replaces a call from X_Inject.singletonAsync(Class, xapi.util.api.ReceivesValue) by first a) generating an async provider, and then b) sending the value receiver into the async provider as a callback.
static com.google.gwt.dev.jjs.ast.JExpression	rebindSingletonLazy(com.google.gwt.core.ext.TreeLogger logger, com.google.gwt.dev.jjs.ast.JMethodCall x, com.google.gwt.dev.jjs.ast.JMethod currentMethod, com.google.gwt.dev.jjs.ast.Context context, UnifyAstView ast) Replaces a call from X_Inject.singletonLazy(Class) by first a-0) generating a provider which will be synchronous if an async call hasn't already been made, or a-1) generating a provider which will route through the async provider, and return null before inited.

Methods inherited from class java.lang.Object

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

Constructor Detail

MagicMethods

public MagicMethods()

Method Detail

rebindSingletonAsync

public static com.google.gwt.dev.jjs.ast.JExpression rebindSingletonAsync(com.google.gwt.core.ext.TreeLogger logger,
                                                          com.google.gwt.dev.jjs.ast.JMethodCall methodCall,
                                                          com.google.gwt.dev.jjs.ast.JMethod currentMethod,
                                                          com.google.gwt.dev.jjs.ast.Context context,
                                                          UnifyAstView ast)
                                                                   throws com.google.gwt.core.ext.UnableToCompleteException

Replaces a call from X_Inject.singletonAsync(Class, xapi.util.api.ReceivesValue) by first a) generating an async provider, and then b) sending the value receiver into the async provider as a callback. See the AsyncProxy class and AsyncInjectionGenerator for implementation.

Parameters:

logger - - The logger to log to.

methodCall - - The method call we are overwriting

currentMethod - - The encapsulated method itself

context - - The method call context, so you can insert clinits / whatnot

ast - - A view over UnifyAst, exposing our basic needs

Returns:

- A JExpression to replace this method call with

Throws:

com.google.gwt.core.ext.UnableToCompleteException

rebindSingletonAndCallback

public static com.google.gwt.dev.jjs.ast.JExpression rebindSingletonAndCallback(com.google.gwt.core.ext.TreeLogger logger,
                                                                com.google.gwt.dev.jjs.ast.JMethodCall methodCall,
                                                                com.google.gwt.dev.jjs.ast.JMethod currentMethod,
                                                                com.google.gwt.dev.jjs.ast.Context context,
                                                                UnifyAstView ast)
                                                                         throws com.google.gwt.core.ext.UnableToCompleteException

Replaces a call from X_Inject.singletonAsync(Class, xapi.util.api.ReceivesValue) by first a) generating an async provider, and then b) sending the value receiver into the async provider as a callback. See the AsyncProxy class and AsyncInjectionGenerator for implementation.

Parameters:

logger - - The logger to log to.

methodCall - - The method call we are overwriting

currentMethod - - The encapsulated method itself

context - - The method call context, so you can insert clinits / whatnot

ast - - A view over UnifyAst, exposing our basic needs

Returns:

- A JExpression to replace this method call with

Throws:

com.google.gwt.core.ext.UnableToCompleteException

rebindSingletonLazy

public static com.google.gwt.dev.jjs.ast.JExpression rebindSingletonLazy(com.google.gwt.core.ext.TreeLogger logger,
                                                         com.google.gwt.dev.jjs.ast.JMethodCall x,
                                                         com.google.gwt.dev.jjs.ast.JMethod currentMethod,
                                                         com.google.gwt.dev.jjs.ast.Context context,
                                                         UnifyAstView ast)

Replaces a call from X_Inject.singletonLazy(Class) by first a-0) generating a provider which will be synchronous if an async call hasn't already been made, or a-1) generating a provider which will route through the async provider, and return null before inited. then b) returning a simple lazy provider which will poll the actual provider until it is set. If you use the X_Inject.singletonAsync(Class, xapi.util.api.ReceivesValue) once, you should not use the other two synchronous provider methods, as they may return null if you happen to request them before the code split containing the service is downloaded.

Parameters:

logger - - The logger to log to.

methodCall - - The method call we are overwriting

currentMethod - - The encapsulated method itself

context - - The method call context, so you can insert clinits / whatnot

ast - - A view over UnifyAst, exposing our basic needs

Returns:

- A JExpression to replace this method call with

rebindSingleton

public static com.google.gwt.dev.jjs.ast.JExpression rebindSingleton(com.google.gwt.core.ext.TreeLogger logger,
                                                     com.google.gwt.dev.jjs.ast.JMethodCall x,
                                                     com.google.gwt.dev.jjs.ast.JMethod currentMethod,
                                                     com.google.gwt.dev.jjs.ast.Context context,
                                                     UnifyAstView ast)

Replaces a call from X_Inject.singleton(Class) by first a-0) generating a provider which will be synchronous if an async call hasn't already been made, or a-1) generating a provider which will route through the async provider, and return null before inited. then b) creates a lazy provider to call into the synchronous provider finally c) calls .get() on the provider and return the value. If you use the X_Inject.singletonAsync(Class, xapi.util.api.ReceivesValue) once, you should not use the other two synchronous provider methods, as they may return null if you happen to request them before the code split containing the service is downloaded.

Parameters:

logger - - The logger to log to.

methodCall - - The method call we are overwriting

currentMethod - - The encapsulated method itself

context - - The method call context, so you can insert clinits / whatnot

ast - - A view over UnifyAst, exposing our basic needs

Returns:

- A JExpression to replace this method call with

rebindNewInstance

public static <T> com.google.gwt.dev.jjs.ast.JExpression rebindNewInstance(com.google.gwt.core.ext.TreeLogger logger,
                                                           com.google.gwt.dev.jjs.ast.JMethodCall x,
                                                           com.google.gwt.dev.jjs.ast.JMethod currentMethod,
                                                           com.google.gwt.dev.jjs.ast.Context context,
                                                           UnifyAstView ast)

rebindInstance

public static com.google.gwt.dev.jjs.ast.JExpression rebindInstance(com.google.gwt.core.ext.TreeLogger logger,
                                                    com.google.gwt.dev.jjs.ast.JMethodCall x,
                                                    com.google.gwt.dev.jjs.ast.JMethod currentMethod,
                                                    com.google.gwt.dev.jjs.ast.Context context,
                                                    UnifyAstView ast)

Replaces a call from X_Inject.singleton(Class) by first a-0) generating a provider which will be synchronous if an async call hasn't already been made, or a-1) generating a provider which will route through the async provider, and return null before inited. then b) creates a lazy provider to call into the synchronous provider finally c) calls .get() on the provider and return the value. If you use the X_Inject.singletonAsync(Class, xapi.util.api.ReceivesValue) once, you should not use the other two synchronous provider methods, as they may return null if you happen to request them before the code split containing the service is downloaded.

Parameters:

logger - - The logger to log to.

methodCall - - The method call we are overwriting

currentMethod - - The encapsulated method itself

context - - The method call context, so you can insert clinits / whatnot

ast - - A view over UnifyAst, exposing our basic needs

Returns:

- A JExpression to replace this method call with