io.werval.api.routes

Interface ReverseRoute

public interface ReverseRoute

Mutable Reverse Route.

Method Summary

Modifier and Type	Method and Description
ReverseRoute	appendQueryString(Map<String,?> parameters) Append a bunch of parameters to this ReverseRoute Query String.
ReverseRoute	appendQueryString(String key, String... values) Append a parameter to this ReverseRoute Query String.
String	httpUrl()
String	httpUrl(boolean secure)
Method	method()
String	uri()
String	webSocketUrl()
String	webSocketUrl(boolean secure)
ReverseRoute	withFragmentIdentifier(String fragmentIdentifier)

Method Detail

method

Method method()

Returns:

HTTP Method

uri

String uri()

Returns:

HTTP URI

appendQueryString

ReverseRoute appendQueryString(String key,
                               String... values)

Append a parameter to this ReverseRoute Query String.

Parameters:

key - QueryString key

values - QueryString values

Returns:

This very ReverseRoute as fluent API

Throws:

IllegalArgumentException - when key is null or empty, or when value is null

appendQueryString

ReverseRoute appendQueryString(Map<String,?> parameters)

Append a bunch of parameters to this ReverseRoute Query String. If the given parameters Map is a Map<String,List<?>> then each value of each list is appended to the Query String.

This is the result of each value's toString() method that is appended to the Query String.

Parameters:

parameters - Parameters as a Map

Returns:

This very ReverseRoute as fluent API

Throws:

IllegalArgumentException - when parameters is null, or when one key is null or empty, or when one value is null

withFragmentIdentifier

ReverseRoute withFragmentIdentifier(String fragmentIdentifier)

Parameters:

fragmentIdentifier - Fragment identifier

Returns:

This very ReverseRoute as fluent API

httpUrl

String httpUrl()

Returns:

Absolute HTTP URL

httpUrl

String httpUrl(boolean secure)

Parameters:

secure - is the URL secure?

Returns:

Absolute HTTP(s) URL

webSocketUrl

String webSocketUrl()

Returns:

Absolute WebSocket URL

webSocketUrl

String webSocketUrl(boolean secure)

Parameters:

secure - is the URL secure?

Returns:

Absolute WebSocket(SSL) URL