com.gwtplatform.dispatch.annotation

Annotation Type GenDispatch

@Target(value=TYPE)
@Retention(value=RUNTIME)
@Inherited
public @interface GenDispatch

Annotation to generate Action and Result classes.

If you type:

 
 @GenDispatch
 public class RetrieveFoo {
   @In(1) Key fooKey;
   @Out(1) Foo foo;
   @Out(2) boolean bar;
 }
 
 

gwt-platform will generate two classes, RetrieveFooAction and RetrieveFooResult.

@In specifies that fooKey will only be used in the action. The number passed to @In specifies the order of the arguments to the constructor.

@Out specifies that foo and bar will only be used in the result. The number passed to @Out specifies the order of the arguments to the constructor.

RetrieveFooAction will have fields, getters, and a constructor for fooKey, plus equals, hashCode, toString etc, for it to function correctly as an Action.

RetrieveFooResult will have fields, getters, and a constructor that accepts food and good, for bar, plus equals, hashCode, toString etc, for it to function correctly as an Result.

Complex example:

 public interface HasThing<T> {
   T getThing();
 }

 @GenDispatch(
     isSecure = false,
     serviceName = Action.DEFAULT_SERVICE_NAME + "MyBar",
     extraResultInterfaces = "com.example.shared.HasThing<com.example.shared.Foo>"
 )
 public class RetrieveBar {
   @In(1) String id;
   @Out(1) Foo thing;
 }
 
 

UpdateBarAction will have the following features;

• The isSecure() method will return false.
• The getServiceName() method will return "dispatch/MyBar".

And the UpdateBarResult object will be able to be passed to something that knows how about the HasThing interface, but does not know about UpdateBarResult.

Notes:

There is no naming requirement for your class name. It will be appended with Action and Result

isSecured Specifies the value that the generated isSecured() method should return. Defaults to true if not specified. See Action for more details.

serviceName Specifies the value that the generated getServiceName() method should return. Defaults to Action.DEFAULT_SERVICE_NAME + "YourClassName" if not specified. See Action for more details.

extraActionInterfaces A comma separated list of fully qualified interfaces that the Action class will implement. Each of the functions defined in the interface must match an function autogenerated using the field definitions.

extraResultInterfaces A comma separated list of fully qualified interfaces that the Result class will implement. Each of the functions defined in the interface must match an function autogenerated using the field definitions.

Author:

Brendan Doherty, Stephen Haberman (concept)

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	extraActionInterfaces
String	extraResultInterfaces
boolean	isSecure
String	serviceName

Element Detail

isSecure

public abstract boolean isSecure

Default:

true

serviceName

public abstract String serviceName

Default:

""

extraActionInterfaces

public abstract String extraActionInterfaces

Default:

""

extraResultInterfaces

public abstract String extraResultInterfaces

Default:

""