io.springlets.web.mvc.support

Class SimpleMethodLinkBuilder<T>

java.lang.Object

io.springlets.web.mvc.support.SimpleMethodLinkBuilder<T>

Type Parameters:

T - the class of the Controller to create links to

All Implemented Interfaces:

MethodLinkBuilder<T>

public class SimpleMethodLinkBuilder<T>
extends Object
implements MethodLinkBuilder<T>

Simple MethodLinkBuilder implementation which delegates the creation of UriComponents instances to its Controller methods through a MethodLinkFactory of the same Controller.

Author:

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

Constructor Summary

Constructors

Constructor and Description
SimpleMethodLinkBuilder(MethodLinkFactory<T> linkFactory, String methodName, Set<io.springlets.web.mvc.support.SimpleMethodLinkBuilder.ParameterIndex> parameters, Map<String,Object> pathVariables) Creates a builder for a Controller's method with the given options.

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.
String	toString()
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleMethodLinkBuilder

public SimpleMethodLinkBuilder(MethodLinkFactory<T> linkFactory,
                               String methodName,
                               Set<io.springlets.web.mvc.support.SimpleMethodLinkBuilder.ParameterIndex> parameters,
                               Map<String,Object> pathVariables)

Creates a builder for a Controller's method with the given options.

Parameters:

linkFactory - to use to create the links

methodName - the name of the Controller's method

parameters - of the method

pathVariables - path variables defined in the the RequestMapping of the method to be replaced

Method Detail

arg

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

Description copied from interface: MethodLinkBuilder

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

Specified by:

arg in interface MethodLinkBuilder<T>

Returns:

the builder with the given method parameters

with

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

Description copied from interface: MethodLinkBuilder

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.

Specified by:

with in interface MethodLinkBuilder<T>

Parameters:

variable - name of the path variable

value - value to replace with

Returns:

the builder with the given path variable

toUri

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

Description copied from interface: MethodLinkBuilder

Creates a UriComponents instance with the current builder configuration.

Specified by:

toUri in interface MethodLinkBuilder<T>

Returns:

the uri to the method with the current configuration

toUriString

public String toUriString()

Description copied from interface: MethodLinkBuilder

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

Specified by:

toUriString in interface MethodLinkBuilder<T>

Returns:

the full URI String

toPath

public String toPath()

Description copied from interface: MethodLinkBuilder

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

Specified by:

toPath in interface MethodLinkBuilder<T>

Returns:

the URI path

toString

public String toString()

Overrides:

toString in class Object