org.springframework.hateoas.mvc

Class ControllerLinkBuilder

java.lang.Object

org.springframework.hateoas.core.LinkBuilderSupport<ControllerLinkBuilder>

org.springframework.hateoas.mvc.ControllerLinkBuilder

All Implemented Interfaces:

LinkBuilder

public class ControllerLinkBuilder
extends LinkBuilderSupport<ControllerLinkBuilder>

Builder to ease building Link instances pointing to Spring MVC controllers.

Author:

Oliver Gierke, Kamill Sokol, Greg Turnquist, Kevin Conaway, Andrew Naydyonock, Oliver Trosien, Greg Turnquist

Method Summary

Modifier and Type	Method and Description
protected ControllerLinkBuilder	createNewInstance(UriComponentsBuilder builder) Creates a new instance of the sub-class.
protected ControllerLinkBuilder	getThis() Returns the current concrete instance.
static ControllerLinkBuilder	linkTo(Class<?> controller) Creates a new ControllerLinkBuilder with a base of the mapping annotated to the given controller class.
static ControllerLinkBuilder	linkTo(Class<?> controller, Map<String,?> parameters) Creates a new ControllerLinkBuilder with a base of the mapping annotated to the given controller class.
static ControllerLinkBuilder	linkTo(Class<?> controller, Method method, Object... parameters)
static ControllerLinkBuilder	linkTo(Class<?> controller, Object... parameters) Creates a new ControllerLinkBuilder with a base of the mapping annotated to the given controller class.
static ControllerLinkBuilder	linkTo(Method method, Object... parameters)
static ControllerLinkBuilder	linkTo(Object invocationValue) Creates a ControllerLinkBuilder pointing to a controller method.
static <T> T	methodOn(Class<T> controller, Object... parameters) Wrapper for DummyInvocationUtils.methodOn(Class, Object...) to be available in case you work with static imports of ControllerLinkBuilder.
String	toString()
UriComponentsBuilder	toUriComponentsBuilder() Returns a UriComponentsBuilder to continue to build the already built URI in a more fine grained way.

Methods inherited from class org.springframework.hateoas.core.LinkBuilderSupport

slash, slash, slash, toUri, withRel, withSelfRel

Methods inherited from class java.lang.Object

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

Method Detail

linkTo

public static ControllerLinkBuilder linkTo(Class<?> controller)

Creates a new ControllerLinkBuilder with a base of the mapping annotated to the given controller class.

Parameters:

controller - the class to discover the annotation on, must not be null.

Returns:

linkTo

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

Creates a new ControllerLinkBuilder with a base of the mapping annotated to the given controller class. The additional parameters are used to fill up potentially available path variables in the class scop request mapping.

Parameters:

controller - the class to discover the annotation on, must not be null.

parameters - additional parameters to bind to the URI template declared in the annotation, must not be null.

Returns:

linkTo

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

Creates a new ControllerLinkBuilder with a base of the mapping annotated to the given controller class. Parameter map is used to fill up potentially available path variables in the class scope request mapping.

Parameters:

controller - the class to discover the annotation on, must not be null.

parameters - additional parameters to bind to the URI template declared in the annotation, must not be null.

Returns:

linkTo

public static ControllerLinkBuilder linkTo(Method method,
                                           Object... parameters)

linkTo

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

linkTo

public static ControllerLinkBuilder linkTo(Object invocationValue)

Creates a ControllerLinkBuilder pointing to a controller method. Hand in a dummy method invocation result you can create via methodOn(Class, Object...) or DummyInvocationUtils.methodOn(Class, Object...).

 @RequestMapping("/customers")
 class CustomerController {
 
   @RequestMapping("/{id}/addresses")
   HttpEntity<Addresses> showAddresses(@PathVariable Long id) { … } 
 }
 
 Link link = linkTo(methodOn(CustomerController.class).showAddresses(2L)).withRel("addresses");
 

The resulting Link instance will point to /customers/2/addresses and have a rel of addresses. For more details on the method invocation constraints, see DummyInvocationUtils.methodOn(Class, Object...).

Parameters:

invocationValue -

Returns:

methodOn

public static <T> T methodOn(Class<T> controller,
                             Object... parameters)

Wrapper for DummyInvocationUtils.methodOn(Class, Object...) to be available in case you work with static imports of ControllerLinkBuilder.

Parameters:

controller - must not be null.

parameters - parameters to extend template variables in the type level mapping.

Returns:

getThis

protected ControllerLinkBuilder getThis()

Description copied from class: LinkBuilderSupport

Returns the current concrete instance.

Specified by:

getThis in class LinkBuilderSupport<ControllerLinkBuilder>

Returns:

createNewInstance

protected ControllerLinkBuilder createNewInstance(UriComponentsBuilder builder)

Description copied from class: LinkBuilderSupport

Creates a new instance of the sub-class.

Specified by:

createNewInstance in class LinkBuilderSupport<ControllerLinkBuilder>

Parameters:

builder - will never be null.

Returns:

toUriComponentsBuilder

public UriComponentsBuilder toUriComponentsBuilder()

Returns a UriComponentsBuilder to continue to build the already built URI in a more fine grained way.

Returns:

toString

public String toString()

Overrides:

toString in class LinkBuilderSupport<ControllerLinkBuilder>