io.springlets.web.mvc.util

Interface MethodLinkBuilder<T>

Type Parameters:

T - the class of the Controller to create links to

All Known Implementing Classes:

SimpleMethodLinkBuilder

public interface MethodLinkBuilder<T>

Build links to controller methods. Provides a simple DSL to set the method parameters as well as the path variables needed to build the URI to the controller method.

Author:

Cèsar Ordiñana at http://www.disid.com[DISID Corporation S.L.]

Method Summary

Modifier and Type	Method and Description
MethodLinkBuilder<T>	arg(int index, Object parameter) Provides parameters for the method.
String	toPath() Returns the Path of the URI String to the method with the current builder configuration.
org.springframework.web.util.UriComponents	toUri() Creates a UriComponents instance with the current builder configuration.
String	toUriString() Returns the full URI String to the method with the current builder configuration.
MethodLinkBuilder<T>	with(String variable, Object value) Adds a path variable to build the method URI.

Method Detail

arg

MethodLinkBuilder<T> arg(int index,
                         Object parameter)

Provides parameters for the method. It will add the given parameters to any previously added ones.

Parameters:

parameters - of the method

Returns:

the builder with the given method parameters

with

MethodLinkBuilder<T> with(String variable,
                          Object value)

Adds a path variable to build the method URI. The variable name must be the same as the one included between {} clauses in the RequestMapping of the method.

Parameters:

variable - name of the path variable

value - value to replace with

Returns:

the builder with the given path variable

toUri

org.springframework.web.util.UriComponents toUri()

Creates a UriComponents instance with the current builder configuration.

Returns:

the uri to the method with the current configuration

toUriString

String toUriString()

Returns the full URI String to the method with the current builder configuration.

Returns:

the full URI String

toPath

String toPath()

Returns the Path of the URI String to the method with the current builder configuration.

Returns:

the URI path