org.uqbar.xtrest.api

Class ControllerAnnotationProcessor

java.lang.Object

org.uqbar.xtrest.api.ControllerAnnotationProcessor

All Implemented Interfaces:

org.eclipse.xtend.lib.macro.TransformationParticipant<org.eclipse.xtend.lib.macro.declaration.MutableClassDeclaration>

public class ControllerAnnotationProcessor
extends Object
implements org.eclipse.xtend.lib.macro.TransformationParticipant<org.eclipse.xtend.lib.macro.declaration.MutableClassDeclaration>

The annotation processor for @link Controller. Like a macro, it participates in the java code construction, so it can generate code. Basically it makes your class extends jetty's @link AbstractHandler So it generates the #handle method which will have an "if-then" block for each action method (annotated with @Get, @Post, etc). For each of them it generates something like

 
 if (annotation.pattern.matches(url)  && request.isVerb(annotation.verb) {
                this.xxxxx(url, baseRequest, request, response)
 }
 
 

Where "xxx" is the name of the original method. So, notice that it changes your original method, introducing parameters.

URL variables

In case the pattern defines variables, then it will introduce them as method parameters Example:

 
         @Get("/books/:id")
  def getBook()
 
 

Will actually be transformed to a method

 
   public Result getBook(String id, String url, Request baseRequest, HttpServletRequest request, HttpServletResponse response)
 
 

HTTP Parameters

In case you need to handle incoming HTTP parameters then you just need to declare them as method parameters. They will be kept in the generated method.

 
         @Get("/books")
  def getBook(String id)
 
 

Will have the same effect as the previous example.

Author:

jfernandes

Field Summary

Fields

Modifier and Type	Field and Description
static List<? extends Class<? extends Annotation>>	verbs

Constructor Summary

Constructors

Constructor and Description
ControllerAnnotationProcessor()

Method Summary

Modifier and Type	Method and Description
void	addParametersToActionMethods(org.eclipse.xtend.lib.macro.declaration.MutableClassDeclaration clazz, org.eclipse.xtend.lib.macro.TransformationContext context)
protected org.eclipse.xtend.lib.macro.declaration.MutableMethodDeclaration	createHandlerMethod(org.eclipse.xtend.lib.macro.declaration.MutableClassDeclaration clazz, org.eclipse.xtend.lib.macro.TransformationContext context)
org.eclipse.xtext.xbase.lib.Pair<String,ArrayList<String>>	createRegexp(String pattern)
void	doTransform(List<? extends org.eclipse.xtend.lib.macro.declaration.MutableClassDeclaration> annotatedTargetElements, org.eclipse.xtend.lib.macro.TransformationContext context)
Iterable<? extends org.eclipse.xtend.lib.macro.declaration.MutableParameterDeclaration>	getHttpParameters(org.eclipse.xtend.lib.macro.declaration.MutableMethodDeclaration m)
org.eclipse.xtend.lib.macro.declaration.Type	httpAnnotation(org.eclipse.xtend.lib.macro.declaration.MutableMethodDeclaration m, org.eclipse.xtend.lib.macro.TransformationContext context)
List<org.eclipse.xtend.lib.macro.declaration.MutableMethodDeclaration>	httpMethods(org.eclipse.xtend.lib.macro.declaration.MutableClassDeclaration clazz, org.eclipse.xtend.lib.macro.TransformationContext context)
boolean	isBodyParameter(org.eclipse.xtend.lib.macro.declaration.MutableParameterDeclaration param, org.eclipse.xtend.lib.macro.TransformationContext context)

Methods inherited from class java.lang.Object

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

Field Detail

verbs

public static final List<? extends Class<? extends Annotation>> verbs

Constructor Detail

ControllerAnnotationProcessor

public ControllerAnnotationProcessor()

Method Detail

doTransform

public void doTransform(List<? extends org.eclipse.xtend.lib.macro.declaration.MutableClassDeclaration> annotatedTargetElements,
                        @Extension
                        org.eclipse.xtend.lib.macro.TransformationContext context)

Specified by:

doTransform in interface org.eclipse.xtend.lib.macro.TransformationParticipant<org.eclipse.xtend.lib.macro.declaration.MutableClassDeclaration>

addParametersToActionMethods

public void addParametersToActionMethods(org.eclipse.xtend.lib.macro.declaration.MutableClassDeclaration clazz,
                                         @Extension
                                         org.eclipse.xtend.lib.macro.TransformationContext context)

createHandlerMethod

protected org.eclipse.xtend.lib.macro.declaration.MutableMethodDeclaration createHandlerMethod(org.eclipse.xtend.lib.macro.declaration.MutableClassDeclaration clazz,
                                                                                               @Extension
                                                                                               org.eclipse.xtend.lib.macro.TransformationContext context)

isBodyParameter

public boolean isBodyParameter(org.eclipse.xtend.lib.macro.declaration.MutableParameterDeclaration param,
                               @Extension
                               org.eclipse.xtend.lib.macro.TransformationContext context)

httpMethods

public List<org.eclipse.xtend.lib.macro.declaration.MutableMethodDeclaration> httpMethods(org.eclipse.xtend.lib.macro.declaration.MutableClassDeclaration clazz,
                                                                                          @Extension
                                                                                          org.eclipse.xtend.lib.macro.TransformationContext context)

getHttpParameters

public Iterable<? extends org.eclipse.xtend.lib.macro.declaration.MutableParameterDeclaration> getHttpParameters(org.eclipse.xtend.lib.macro.declaration.MutableMethodDeclaration m)

httpAnnotation

public org.eclipse.xtend.lib.macro.declaration.Type httpAnnotation(org.eclipse.xtend.lib.macro.declaration.MutableMethodDeclaration m,
                                                                   @Extension
                                                                   org.eclipse.xtend.lib.macro.TransformationContext context)

createRegexp

public org.eclipse.xtext.xbase.lib.Pair<String,ArrayList<String>> createRegexp(String pattern)