org.springframework.hateoas.server

Interface MethodLinkBuilderFactory<T extends LinkBuilder>

All Superinterfaces:

LinkBuilderFactory<T>

All Known Implementing Classes:

ControllerLinkBuilderFactory, WebMvcLinkBuilderFactory

public interface MethodLinkBuilderFactory<T extends LinkBuilder>
extends LinkBuilderFactory<T>

Extension of LinkBuilderFactory for implementations that also support creating LinkBuilders by pointing to a method.

Author:

Oliver Gierke

Method Summary

Modifier and Type	Method and Description
T	linkTo(Class<?> type, 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.
T	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.
T	linkTo(Object methodInvocationResult) Returns a LinkBuilder pointing to the URI mapped to the method the result is handed into this method.

Methods inherited from interface org.springframework.hateoas.server.LinkBuilderFactory

linkTo, linkTo, linkTo

Method Detail

linkTo

T 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.

Parameters:

method - must not be null.

parameters -

Returns:

linkTo

T linkTo(Class<?> type,
         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.

Parameters:

type - must not be null.

method - must not be null.

parameters -

Returns:

linkTo

T linkTo(Object methodInvocationResult)

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.

Parameters:

methodInvocationResult - must not be null.

Returns:

See Also:

WebMvcLinkBuilder.linkTo(Object)