Spring Hateoas

org.springframework.hateoas
Interface MethodLinkBuilderFactory<T extends LinkBuilder>

All Superinterfaces:
LinkBuilderFactory<T>
All Known Implementing Classes:
ControllerLinkBuilderFactory

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
 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.LinkBuilderFactory
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 ControllerLinkBuilder.linkTo(Object) for an example.

Parameters:
methodInvocationResult - must not be null.
Returns:
See Also:
ControllerLinkBuilder.linkTo(Object)

Spring Hateoas

Copyright © 2012-2014-2014 Pivotal, Inc.. All Rights Reserved.