ninja

Class Route

java.lang.Object

ninja.Route

public class Route
extends java.lang.Object

A route

Constructor Summary

Constructors

Constructor and Description
Route(java.lang.String httpMethod, java.lang.String uri, java.lang.Class controllerClass, java.lang.reflect.Method controllerMethod, FilterChain filterChain)

Method Summary

Modifier and Type	Method and Description
protected static java.lang.String	convertRawUriToRegex(java.lang.String rawUri) Gets a raw uri like "/{name}/id/*" and returns "/([^/]*)/id/*." Also handles regular expressions if defined inside routes: For instance "/users/{username: [a-zA-Z][a-zA-Z_0-9]}" becomes "/users/([a-zA-Z][a-zA-Z_0-9])"
java.lang.Class<?>	getControllerClass()
java.lang.reflect.Method	getControllerMethod()
FilterChain	getFilterChain()
java.lang.String	getHttpMethod()
java.util.Map<java.lang.String,java.lang.String>	getPathParametersEncoded(java.lang.String uri) This method does not do any decoding / encoding.
java.lang.String	getUri()
java.lang.String	getUrl()
boolean	matches(java.lang.String httpMethod, java.lang.String uri) Matches /index to /index or /me/1 to /person/{id}

Methods inherited from class java.lang.Object

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

Constructor Detail

Route

public Route(java.lang.String httpMethod,
             java.lang.String uri,
             java.lang.Class controllerClass,
             java.lang.reflect.Method controllerMethod,
             FilterChain filterChain)

Method Detail

getUrl

public java.lang.String getUrl()

getHttpMethod

public java.lang.String getHttpMethod()

getUri

public java.lang.String getUri()

getControllerClass

public java.lang.Class<?> getControllerClass()

getFilterChain

public FilterChain getFilterChain()

getControllerMethod

public java.lang.reflect.Method getControllerMethod()

matches

public boolean matches(java.lang.String httpMethod,
                       java.lang.String uri)

Matches /index to /index or /me/1 to /person/{id}

Returns:

True if the actual route matches a raw rout. False if not.

getPathParametersEncoded

public java.util.Map<java.lang.String,java.lang.String> getPathParametersEncoded(java.lang.String uri)

This method does not do any decoding / encoding. If you want to decode you have to do it yourself. Most likely with: http://docs.oracle.com/javase/6/docs/api/java/net/URI.html

Parameters:

uri - The whole encoded uri.

Returns:

A map with all parameters of that uri. Encoded in => encoded out.

convertRawUriToRegex

protected static java.lang.String convertRawUriToRegex(java.lang.String rawUri)

Gets a raw uri like "/{name}/id/*" and returns "/([^/]*)/id/*." Also handles regular expressions if defined inside routes: For instance "/users/{username: [a-zA-Z][a-zA-Z_0-9]}" becomes "/users/([a-zA-Z][a-zA-Z_0-9])"

Returns:

The converted regex with default matching regex - or the regex specified by the user.