com.gwtplatform.mvp.rebind

Class ClassInspector

java.lang.Object

com.gwtplatform.mvp.rebind.ClassInspector

public class ClassInspector
extends Object

A helper class that can be used to inspect a class for methods having specific signatures.

Author:

Philippe Beaudoin

Method Summary

Methods

Modifier and Type	Method and Description
void	collectAnnotatedMethods(Class<? extends Annotation> annotation, List<JMethod> collection) Collects the methods to find one annotated with the specified annotation.
void	collectStaticAnnotatedFields(JClassType type, JClassType typeParameter, Class<? extends Annotation> annotation, List<JField> collection) Inspects the fields to collect the ones of the specified parameterized type with the specified type as a parameter annotated with the specified annotation.
JMethod	findAnnotatedMethod(Class<? extends Annotation> annotation) Inspects the methods to find one annotated with the specified annotation.
JMethod	findAnnotatedMethodWithoutParamsReturning(JClassType returnType, Class<? extends Annotation> annotation, boolean failIfAnnotationIsFoundOnWrongMethod) Inspects the methods to find one that return the specified type and is annotated with the specified annotation.
JMethod	findMethod(String methodName, JClassType parameterType) Inspects the class for a method with the given name and taking exactly one parameter of the specified type, or of a subtype of that type.
JMethod	findMethodWithoutParamsReturning(JClassType returnType) Inspects the methods to find one that return the specified type.
JMethod	findMethodWithoutParamsReturning(JGenericType returnType, JClassType returnTypeParameter) Inspects the methods to find one that return the specified parameterized type with the specified type as a parameter.
List<JMethod>	getAllMethods() Collects all methods from either the inspected class or any of its parent classes.

Methods inherited from class java.lang.Object

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

Method Detail

findMethodWithoutParamsReturning

public JMethod findMethodWithoutParamsReturning(JClassType returnType)
                                         throws UnableToCompleteException

Inspects the methods to find one that return the specified type. The method can be either in the inspected class or any of its parent classes. It can be static or not.

Parameters:

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

Returns:

The method returning returnType, or null if not found.

Throws:

UnableToCompleteException - If more than one matching method is found.

findMethodWithoutParamsReturning

public JMethod findMethodWithoutParamsReturning(JGenericType returnType,
                                       JClassType returnTypeParameter)
                                         throws UnableToCompleteException

Inspects the methods to find one that return the specified parameterized type with the specified type as a parameter. The method can be either in the inspected class or any of its parent classes. It can be static or not.

Parameters:

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

returnTypeParameter - The type parameter of returnType.

Returns:

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

Throws:

UnableToCompleteException - If more than one matching method is found.

findAnnotatedMethodWithoutParamsReturning

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

Inspects the methods to find one that return the specified type and is annotated with the specified annotation. The method can be either in the inspected class or any of its parent classes. It can be static or not.

Parameters:

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

annotation - The annotation that should be present on the 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 method returning returnType and annotated with annotation, or null if not found.

Throws:

UnableToCompleteException - If more than one matching method is found, or if the annotation is found on another method and failIfAnnotationIsFoundOnWrongMethod is true.

findAnnotatedMethod

public JMethod findAnnotatedMethod(Class<? extends Annotation> annotation)
                            throws UnableToCompleteException

Inspects the methods to find one annotated with the specified annotation. The method can be either in the inspected class or any of its parent classes. It can be static or not.

Parameters:

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

Returns:

The method annotated with annotation, or null if not found.

Throws:

UnableToCompleteException - If more than one matching method is found.

findMethod

public JMethod findMethod(String methodName,
                 JClassType parameterType)

Inspects the class for a method with the given name and taking exactly one parameter of the specified type, or of a subtype of that type.

Parameters:

methodName - The name of the method to look for.

parameterType - The type of the unique parameter accepted by that method.

Returns:

The method, or null if not found.

collectAnnotatedMethods

public void collectAnnotatedMethods(Class<? extends Annotation> annotation,
                           List<JMethod> collection)

Collects the methods to find one annotated with the specified annotation. The method can be either in the inspected class or any of its parent classes. It can be static or not.

Parameters:

annotation - The annotation that should be present on the methods.

collection - The list in which to collect matching methods.

getAllMethods

public List<JMethod> getAllMethods()

Collects all methods from either the inspected class or any of its parent classes.

collectStaticAnnotatedFields

public void collectStaticAnnotatedFields(JClassType type,
                                JClassType typeParameter,
                                Class<? extends Annotation> annotation,
                                List<JField> collection)
                                  throws UnableToCompleteException

Inspects the fields to collect the ones of the specified parameterized type with the specified type as a parameter annotated with the specified annotation. The field can be either in the inspected class or any of its parent classes. Only static fields are collected.

Parameters:

type - The parameterized type of the desired fields.

typeParameter - The type parameter of type.

annotation - The annotation that should be present on the field.

collection - The list in which to collect matching fields.

Throws:

UnableToCompleteException - If a field annotated with annotation is found that does not respect the other criteria of the search.