org.springframework.hateoas

Interface LinkBuilderFactory<T extends LinkBuilder>

All Known Subinterfaces:

MethodLinkBuilderFactory<T>

All Known Implementing Classes:

ControllerLinkBuilderFactory, JaxRsLinkBuilderFactory

public interface LinkBuilderFactory<T extends LinkBuilder>

Factory for LinkBuilder instances.

Author:

Ricardo Gladwell, Andrew Naydyonock, Oliver Gierke

Method Summary

Modifier and Type	Method and Description
T	linkTo(Class<?> target) Creates a new LinkBuilder with a base of the mapping annotated to the given target class (controller, service, etc.).
T	linkTo(Class<?> target, Map<String,?> parameters) Creates a new LinkBuilder with a base of the mapping annotated to the given target class (controller, service, etc.).
T	linkTo(Class<?> target, Object... parameters) Creates a new LinkBuilder with a base of the mapping annotated to the given target class (controller, service, etc.).

Method Detail

linkTo

T linkTo(Class<?> target)

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

Parameters:

target - must not be null.

Returns:

linkTo

T linkTo(Class<?> target,
         Object... parameters)

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.

Parameters:

target - must not be null.

parameters - must not be null.

Returns:

linkTo

T linkTo(Class<?> target,
         Map<String,?> parameters)

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.

Parameters:

target - must not be null.

parameters - must not be null.

Returns: