ninja

Class ReverseRouter.Builder

java.lang.Object

ninja.ReverseRouter.Builder

Enclosing class:

ReverseRouter

public static class ReverseRouter.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder(String contextPath, Route route)

Method Summary

Modifier and Type	Method and Description
ReverseRouter.Builder	absolute(Context context) Make this an absolute route by including the current scheme (e.g.
ReverseRouter.Builder	absolute(String scheme, String hostname) Make this an absolute route by including the current scheme (e.g.
String	build() Builds the final url.
Map<String,String>	getPathParams()
Map<String,String>	getQueryParams()
Route	getRoute()
ReverseRouter.Builder	pathParam(String name, Object value) Add a parameter as a path replacement.
ReverseRouter.Builder	queryParam(String name, Object value) Add a parameter as a queryParam string value.
ReverseRouter.Builder	rawPathParam(String name, Object value) Identical to path except the path parameter value will NOT be url encoded when building the final url.
ReverseRouter.Builder	rawQueryParam(String name, Object value) Identical to queryParam except the queryParam string value will NOT be url encoded when building the final url.
Result	redirect() Builds the result as a ninja.Result redirect.
ReverseRouter.Builder	scheme(String scheme)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(String contextPath,
               Route route)

Method Detail

scheme

public ReverseRouter.Builder scheme(String scheme)

absolute

public ReverseRouter.Builder absolute(String scheme,
                                      String hostname)

Make this an absolute route by including the current scheme (e.g. http) and hostname (e.g. www.example.com).

Parameters:

scheme - The scheme such as "http" or "https"

hostname - The hostname such as "www.example.com" or "www.example.com:8080"

Returns:

This builder

absolute

public ReverseRouter.Builder absolute(Context context)

Make this an absolute route by including the current scheme (e.g. http) and hostname (e.g. www.example.com). If the route is to a websocket then this will then return "ws" or "wss" if TLS is detected.

Parameters:

context - The current context

Returns:

This builder

getRoute

public Route getRoute()

getPathParams

public Map<String,String> getPathParams()

getQueryParams

public Map<String,String> getQueryParams()

pathParam

public ReverseRouter.Builder pathParam(String name,
                                       Object value)

Add a parameter as a path replacement. Will validate the path parameter exists. This method will URL encode the values when building the final result.

Parameters:

name - The path parameter name

value - The path parameter value

Returns:

A reference to this builder

See Also:

rawPathParam(java.lang.String, java.lang.Object)

rawPathParam

public ReverseRouter.Builder rawPathParam(String name,
                                          Object value)

Identical to path except the path parameter value will NOT be url encoded when building the final url.

Parameters:

name - The path parameter name

value - The path parameter value

Returns:

A reference to this builder

See Also:

pathParam(java.lang.String, java.lang.Object)

queryParam

public ReverseRouter.Builder queryParam(String name,
                                        Object value)

Add a parameter as a queryParam string value. This method will URL encode the values when building the final result.

Parameters:

name - The queryParam string parameter name

value - The queryParam string parameter value

Returns:

A reference to this builder

See Also:

rawQueryParam(java.lang.String, java.lang.Object)

rawQueryParam

public ReverseRouter.Builder rawQueryParam(String name,
                                           Object value)

Identical to queryParam except the queryParam string value will NOT be url encoded when building the final url.

Parameters:

name - The queryParam string parameter name

value - The queryParam string parameter value

Returns:

A reference to this builder

See Also:

queryParam(java.lang.String, java.lang.Object)

build

public String build()

Builds the final url. Will validate expected parameters match actual.

Returns:

The final resulting url

redirect

public Result redirect()

Builds the result as a ninja.Result redirect.

Returns:

A Ninja redirect result

toString

public String toString()

Overrides:

toString in class Object