Package org.springframework.hateoas.server.mvc

Class WebMvcLinkBuilderFactory

java.lang.Object

org.springframework.hateoas.server.mvc.WebMvcLinkBuilderFactory

All Implemented Interfaces:

LinkBuilderFactory<WebMvcLinkBuilder>, MethodLinkBuilderFactory<WebMvcLinkBuilder>

public class WebMvcLinkBuilderFactory
extends Object
implements MethodLinkBuilderFactory<WebMvcLinkBuilder>

Factory for LinkBuilderSupport instances based on the request mapping annotated on the given controller.

Author:

Ricardo Gladwell, Oliver Gierke, Dietrich Schulten, Kamill Sokol, Ross Turner, Oemer Yildiz, Kevin Conaway, Andrew Naydyonock, Greg Turnquist, Réda Housni Alaoui

Constructor Summary

Constructors

Constructor	Description
WebMvcLinkBuilderFactory()

Method Summary

Modifier and Type	Method	Description
WebMvcLinkBuilder	linkTo(Class<?> controller)	Creates a new LinkBuilder with a base of the mapping annotated to the given target class (controller, service, etc.).
WebMvcLinkBuilder	linkTo(Class<?> controller, Object... parameters)	Creates a new LinkBuilder with a base of the mapping annotated to the given target class (controller, service, etc.).
WebMvcLinkBuilder	linkTo(Class<?> type, Method method)	Returns a LinkBuilder pointing to the URI mapped to the given Method assuming it was invoked on an object of the given type expanding the mapping using null values as parameters.
WebMvcLinkBuilder	linkTo(Class<?> controller, Method method, Object... parameters)	Returns a LinkBuilder pointing to the URI mapped to the given Method assuming it was invoked on an object of the given type.
WebMvcLinkBuilder	linkTo(Class<?> controller, Map<String,?> parameters)	Creates a new LinkBuilder with a base of the mapping annotated to the given target class (controller, service, etc.).
WebMvcLinkBuilder	linkTo(Object invocationValue)	Returns a LinkBuilder pointing to the URI mapped to the method the result is handed into this method.
WebMvcLinkBuilder	linkTo(Method method)	Returns a LinkBuilder pointing to the URI mapped to the given Method and expanding this mapping using null values as parameters.
WebMvcLinkBuilder	linkTo(Method method, Object... parameters)	Returns a LinkBuilder pointing to the URI mapped to the given Method and expanding this mapping using the given parameters.
void	setUriComponentsContributors(List<? extends UriComponentsContributor> uriComponentsContributors)	Configures the UriComponentsContributor to be used when building Link instances from method invocations.

Methods inherited from class java.lang.Object

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

Constructor Details

WebMvcLinkBuilderFactory

public WebMvcLinkBuilderFactory()

Method Details

setUriComponentsContributors

public void setUriComponentsContributors(List<? extends UriComponentsContributor> uriComponentsContributors)

Configures the UriComponentsContributor to be used when building Link instances from method invocations.

Parameters:

uriComponentsContributors - the uriComponentsContributors to set

See Also:

• linkTo(Object)

linkTo

public WebMvcLinkBuilder linkTo(Class<?> controller)

Description copied from interface: LinkBuilderFactory

Creates a new LinkBuilder with a base of the mapping annotated to the given target class (controller, service, etc.).

Specified by:

linkTo in interface LinkBuilderFactory<WebMvcLinkBuilder>

Parameters:

controller - must not be null.

Returns:

linkTo

public WebMvcLinkBuilder linkTo(Class<?> controller,
 Object... parameters)

Description copied from interface: LinkBuilderFactory

Creates a new LinkBuilder with a base of the mapping annotated to the given target class (controller, service, etc.). The additional parameters are used to fill up potentially available path variables in the class scope request mapping.

Specified by:

linkTo in interface LinkBuilderFactory<WebMvcLinkBuilder>

Parameters:

controller - must not be null.

parameters - must not be null.

Returns:

linkTo

public WebMvcLinkBuilder linkTo(Class<?> controller,
 Map<String,?> parameters)

Description copied from interface: LinkBuilderFactory

Creates a new LinkBuilder with a base of the mapping annotated to the given target class (controller, service, etc.). Parameter map is used to fill up potentially available path variables in the class scope request mapping.

Specified by:

linkTo in interface LinkBuilderFactory<WebMvcLinkBuilder>

Parameters:

controller - must not be null.

parameters - must not be null.

Returns:

linkTo

public WebMvcLinkBuilder linkTo(Method method)

Description copied from interface: MethodLinkBuilderFactory

Returns a LinkBuilder pointing to the URI mapped to the given Method and expanding this mapping using null values as parameters.

Specified by:

linkTo in interface MethodLinkBuilderFactory<WebMvcLinkBuilder>

Parameters:

method - must not be null.

Returns:

linkTo

public WebMvcLinkBuilder linkTo(Method method,
 Object... parameters)

Description copied from interface: MethodLinkBuilderFactory

Returns a LinkBuilder pointing to the URI mapped to the given Method and expanding this mapping using the given parameters. The number of parameter values has to match the length of the given method's expected parameters.

Specified by:

linkTo in interface MethodLinkBuilderFactory<WebMvcLinkBuilder>

Parameters:

method - must not be null.

Returns:

linkTo

public WebMvcLinkBuilder linkTo(Class<?> type,
 Method method)

Description copied from interface: MethodLinkBuilderFactory

Returns a LinkBuilder pointing to the URI mapped to the given Method assuming it was invoked on an object of the given type expanding the mapping using null values as parameters.

Specified by:

linkTo in interface MethodLinkBuilderFactory<WebMvcLinkBuilder>

Parameters:

type - must not be null.

method - must not be null.

Returns:

linkTo

public WebMvcLinkBuilder linkTo(Class<?> controller,
 Method method,
 Object... parameters)

Description copied from interface: MethodLinkBuilderFactory

Returns a LinkBuilder pointing to the URI mapped to the given Method assuming it was invoked on an object of the given type. The number of parameter values has to match the length of the given method's expected parameters.

Specified by:

linkTo in interface MethodLinkBuilderFactory<WebMvcLinkBuilder>

Parameters:

controller - must not be null.

method - must not be null.

Returns:

linkTo

public WebMvcLinkBuilder linkTo(Object invocationValue)

Description copied from interface: MethodLinkBuilderFactory

Returns a LinkBuilder pointing to the URI mapped to the method the result is handed into this method. Use DummyInvocationUtils#methodOn(Class, Object...) to obtain a dummy instance of a controller to record a dummy method invocation on. See WebMvcLinkBuilder#linkTo(Object) for an example.

Specified by:

linkTo in interface MethodLinkBuilderFactory<WebMvcLinkBuilder>

Parameters:

invocationValue - must not be null.

Returns:

See Also:

• WebMvcLinkBuilder#linkTo(Object)