com.gwtplatform.mvp.rebind

Class PresenterInspector

java.lang.Object

com.gwtplatform.mvp.rebind.PresenterInspector

public class PresenterInspector
extends Object

A class used to inspect the presenter, the methods and inner interfaces it contains. You must call init(JClassType) before any other method can be called.

Author:

Philippe Beaudoin

Constructor Summary

Constructors

Constructor and Description
PresenterInspector(TypeOracle oracle, TreeLogger logger, ClassCollection classCollection, GinjectorInspector ginjectorInspector)

Method Summary

Methods

Modifier and Type	Method and Description
void	collectProxyEvents(List<ProxyEventMethod> proxyEventMethods) Collect all the ProxyEventMethod of methods annotated with @ProxyEvent and contained in the presenter or its super classes.
PresenterTitleMethod	findPresenterTitleMethod() Look in the presenter and any superclass for a method annotated with TitleFunction.
TabInfoMethod	findTabInfoMethod() Retrieves the static TabInfoMethod defined in the presenter.
JClassType	getPresenterClass()
String	getPresenterClassName()
boolean	init(JClassType proxyInterface) Initializes the presenter inspector given the annotation present on a proxy interface.
void	writeContentSlotHandlerRegistration(com.google.gwt.user.rebind.SourceWriter writer) Register a RevealContentHandler for each @ContentSlot defined in the presenter.
void	writeProviderAssignation(com.google.gwt.user.rebind.SourceWriter writer) Writes the assignation into the provider field of ProxyImpl.

Methods inherited from class java.lang.Object

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

Constructor Detail

PresenterInspector

public PresenterInspector(TypeOracle oracle,
                  TreeLogger logger,
                  ClassCollection classCollection,
                  GinjectorInspector ginjectorInspector)

Method Detail

init

public boolean init(JClassType proxyInterface)
             throws UnableToCompleteException

Initializes the presenter inspector given the annotation present on a proxy interface. The possible annotations are ProxyStandard, ProxyCodeSplit or ProxyCodeSplitBundle. If none are present the method returns false and no code should be generated.

Parameters:

proxyInterface - The annotated interface inheriting from proxy and that should be annotated.

Returns:

true if the presenter provider was built, false if the interface wasn't annotated indicating that no proxy should be generated.

Throws:

UnableToCompleteException - When more than one annotation is present on the proxy interface.

getPresenterClass

public JClassType getPresenterClass()

Returns:

The class of the presenter that this PresenterInspector provides.

getPresenterClassName

public String getPresenterClassName()

Returns:

The name of the class of the presenter that this PresenterInspector provides.

writeProviderAssignation

public void writeProviderAssignation(com.google.gwt.user.rebind.SourceWriter writer)

Writes the assignation into the provider field of ProxyImpl.

writeContentSlotHandlerRegistration

public void writeContentSlotHandlerRegistration(com.google.gwt.user.rebind.SourceWriter writer)

Register a RevealContentHandler for each @ContentSlot defined in the presenter.

findPresenterTitleMethod

public PresenterTitleMethod findPresenterTitleMethod()
                                              throws UnableToCompleteException

Look in the presenter and any superclass for a method annotated with TitleFunction.

Throws:

UnableToCompleteException

collectProxyEvents

public void collectProxyEvents(List<ProxyEventMethod> proxyEventMethods)
                        throws UnableToCompleteException

Collect all the ProxyEventMethod of methods annotated with @ProxyEvent and contained in the presenter or its super classes.

Parameters:

proxyEventMethods - The list into which to collect the proxy events.

Throws:

UnableToCompleteException - If something goes wrong. An error will be logged.

findTabInfoMethod

public TabInfoMethod findTabInfoMethod()
                                throws UnableToCompleteException

Retrieves the static TabInfoMethod defined in the presenter.

Returns:

The TabInfoMethod, or null if none is found.

Throws:

UnableToCompleteException - If something goes wrong. An error will be logged.