br.com.caelum.vraptor.http.route

Class PathAnnotationRoutesParser

java.lang.Object

br.com.caelum.vraptor.http.route.PathAnnotationRoutesParser

All Implemented Interfaces:

RoutesParser

@ApplicationScoped
public class PathAnnotationRoutesParser
extends Object
implements RoutesParser

The default parser routes creator uses the path annotation to create rules. Note that methods are only registered to be public accessible if the type is annotated with @Resource. If you want to override the convention for default URI, you can create a class like: public class MyRoutesParser extends PathAnnotationRoutesParser { //delegate constructor protected String extractControllerNameFrom(Class<?> type) { return //your convention here } protected String defaultUriFor(String controllerName, String methodName) { return //your convention here } }

Author:

Guilherme Silveira, Lucas Cavalcanti

Constructor Summary

Constructors

Constructor and Description
PathAnnotationRoutesParser(Router router)

Method Summary

Methods

Modifier and Type	Method and Description
protected String	defaultUriFor(String controllerName, String methodName) You can override this method for use a different convention for your default URI, given a controller name and a method name
protected String	extractControllerNameFrom(Class<?> type) You can override this method for use a different convention for your controller name, given a type
protected String	extractPrefix(Class<?> type)
protected void	fixURIs(Class<?> type, String[] uris)
protected EnumSet<HttpMethod>	getHttpMethods(AnnotatedElement annotated)
protected String[]	getURIsFor(Method javaMethod, Class<?> type)
protected boolean	isEligible(Method javaMethod)
protected String	lowerFirstCharacter(String baseName)
protected List<Route>	registerRulesFor(Class<?> baseType)
protected String	removeTrailingSlash(String prefix)
List<Route>	rulesFor(ResourceClass resource)

Methods inherited from class java.lang.Object

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

Constructor Detail

PathAnnotationRoutesParser

public PathAnnotationRoutesParser(Router router)

Method Detail

rulesFor

public List<Route> rulesFor(ResourceClass resource)

Specified by:

rulesFor in interface RoutesParser

registerRulesFor

protected List<Route> registerRulesFor(Class<?> baseType)

getHttpMethods

protected EnumSet<HttpMethod> getHttpMethods(AnnotatedElement annotated)

isEligible

protected boolean isEligible(Method javaMethod)

getURIsFor

protected String[] getURIsFor(Method javaMethod,
                  Class<?> type)

fixURIs

protected void fixURIs(Class<?> type,
           String[] uris)

removeTrailingSlash

protected String removeTrailingSlash(String prefix)

extractPrefix

protected String extractPrefix(Class<?> type)

extractControllerNameFrom

protected String extractControllerNameFrom(Class<?> type)

You can override this method for use a different convention for your controller name, given a type

defaultUriFor

protected String defaultUriFor(String controllerName,
                   String methodName)

You can override this method for use a different convention for your default URI, given a controller name and a method name

lowerFirstCharacter

protected String lowerFirstCharacter(String baseName)