com.gwtplatform.mvp.rebind

Class GinjectorInspector

java.lang.Object

com.gwtplatform.mvp.rebind.GinjectorInspector

public class GinjectorInspector
extends Object

This class is used to inspect the user-provided ginjector. This is typically useful to identify 'get' methods that generate specific types. You must call init() before any other method can be called.

Author:

Philippe Beaudoin

Method Summary

Methods

Modifier and Type	Method and Description
String	findAnnotatedGetMethod(JClassType returnType, Class<? extends Annotation> annotation, boolean failIfAnnotationIsFoundOnWrongMethod) Looks at the ginjector methods to find one that return the specified type and that is annotated with the specified annotation.
String	findGetMethod(JClassType returnType) Looks at the ginjector methods to find one that return the specified type.
String	findGetMethod(JGenericType returnType, JClassType returnTypeParameter) Looks at the ginjector methods to find one that return the specified parameterized type with the specified type as a parameter.
JClassType	getGinjectorClass() Access the ginjector class.
String	getGinjectorClassName() Access the ginjector class name.
void	init() Initializes the ginjector inspector.

Methods inherited from class java.lang.Object

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

Method Detail

getGinjectorClassName

public String getGinjectorClassName()

Access the ginjector class name.

Returns:

The ginjector class name.

getGinjectorClass

public JClassType getGinjectorClass()

Access the ginjector class.

Returns:

The ginjector class.

init

public void init()
          throws UnableToCompleteException

Initializes the ginjector inspector. Finds the ginjector class given the value of the GWT configuration property gin.ginjector.

Throws:

UnableToCompleteException - If the ginjector property or class cannot be found, an error is logged.

findGetMethod

public String findGetMethod(JClassType returnType)
                     throws UnableToCompleteException

Looks at the ginjector methods to find one that return the specified type. The get method can be either in the ginjector or any of its parent class.

Parameters:

returnType - The type that should be returned by the get method.

Returns:

The get method returning returnType<returnTypeParameter>, or null if not found.

Throws:

UnableToCompleteException - If more than one matching method is found.

findGetMethod

public String findGetMethod(JGenericType returnType,
                   JClassType returnTypeParameter)
                     throws UnableToCompleteException

Looks at the ginjector methods to find one that return the specified parameterized type with the specified type as a parameter. The get method can be either in the ginjector or any of its parent class.

Parameters:

returnType - The parameterized type that should be returned by the get method.

returnTypeParameter - The type parameter of returnType.

Returns:

The get method returning returnType<returnTypeParameter>, or null if not found.

Throws:

UnableToCompleteException - If more than one matching method is found.

findAnnotatedGetMethod

public String findAnnotatedGetMethod(JClassType returnType,
                            Class<? extends Annotation> annotation,
                            boolean failIfAnnotationIsFoundOnWrongMethod)
                              throws UnableToCompleteException

Looks at the ginjector methods to find one that return the specified type and that is annotated with the specified annotation. The get method can be either in the ginjector or any of its parent class.

Parameters:

returnType - The type that should be returned by the get method.

annotation - The annotation that should be present on the get method.

failIfAnnotationIsFoundOnWrongMethod - If true, the call will throw an UnableToCompleteException and log an error if the annotation is found on the wrong method.

Returns:

The get method returning returnType and annotated with annotation, or null if not found.

Throws:

UnableToCompleteException - If more than one matching method is found.