org.springframework.hateoas.jaxrs

Class JaxRsLinkBuilderFactory

java.lang.Object

org.springframework.hateoas.jaxrs.JaxRsLinkBuilderFactory

All Implemented Interfaces:

LinkBuilderFactory<JaxRsLinkBuilder>

public class JaxRsLinkBuilderFactory
extends Object
implements LinkBuilderFactory<JaxRsLinkBuilder>

Factory for LinkBuilder instances based on the path mapping annotated on the given JAX-RS service.

Author:

Ricardo Gladwell, Oliver Gierke, Andrew Naydyonock

Constructor Summary

Constructors

Constructor and Description
JaxRsLinkBuilderFactory()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

JaxRsLinkBuilderFactory

public JaxRsLinkBuilderFactory()

Method Detail

linkTo

public JaxRsLinkBuilder linkTo(Class<?> service)

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<JaxRsLinkBuilder>

Parameters:

service - must not be null.

Returns:

linkTo

public JaxRsLinkBuilder linkTo(Class<?> service,
                               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<JaxRsLinkBuilder>

Parameters:

service - must not be null.

parameters - must not be null.

Returns:

linkTo

public JaxRsLinkBuilder linkTo(Class<?> service,
                               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<JaxRsLinkBuilder>

Parameters:

service - must not be null.

parameters - must not be null.

Returns: