org.springframework.data.web

Class HateoasPageableHandlerMethodArgumentResolver

java.lang.Object

org.springframework.data.web.PageableHandlerMethodArgumentResolver

org.springframework.data.web.HateoasPageableHandlerMethodArgumentResolver

All Implemented Interfaces:

org.springframework.hateoas.mvc.UriComponentsContributor, HandlerMethodArgumentResolver

public class HateoasPageableHandlerMethodArgumentResolver
extends PageableHandlerMethodArgumentResolver
implements org.springframework.hateoas.mvc.UriComponentsContributor

Extension of PageableHandlerMethodArgumentResolver that also supports enhancing URIs using Spring HATEOAS support.

Since:

1.6

Author:

Oliver Gierke, Nick Williams

Field Summary

Fields

Modifier and Type	Field and Description
static HateoasPageableHandlerMethodArgumentResolver	LEGACY Deprecated.

Constructor Summary

Constructors

Constructor and Description
HateoasPageableHandlerMethodArgumentResolver() Constructs an instance of this resolver with a default HateoasSortHandlerMethodArgumentResolver.
HateoasPageableHandlerMethodArgumentResolver(HateoasSortHandlerMethodArgumentResolver sortResolver) Creates a new HateoasPageableHandlerMethodArgumentResolver using the given HateoasSortHandlerMethodArgumentResolver..

Method Summary

Methods

Modifier and Type	Method and Description
void	enhance(UriComponentsBuilder builder, MethodParameter parameter, Object value)
org.springframework.hateoas.TemplateVariables	getPaginationTemplateVariables(MethodParameter parameter, UriComponents template) Returns the template variable for the pagination parameters.

Methods inherited from class org.springframework.data.web.PageableHandlerMethodArgumentResolver

getMaxPageSize, getPageParameterName, getParameterNameToUse, getSizeParameterName, isOneIndexedParameters, resolveArgument, setFallbackPageable, setMaxPageSize, setOneIndexedParameters, setPageParameterName, setPrefix, setQualifierDelimiter, setSizeParameterName, supportsParameter

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.hateoas.mvc.UriComponentsContributor

supportsParameter

Field Detail

LEGACY

@Deprecated
public static final HateoasPageableHandlerMethodArgumentResolver LEGACY

Deprecated.

A HateoasPageableHandlerMethodArgumentResolver preconfigured to the setup of PageableArgumentResolver. Use that if you need to stick to the former request parameters an 1-indexed behavior. This will be removed in the next major version (1.7). So consider migrating to the new way of exposing request parameters.

Constructor Detail

HateoasPageableHandlerMethodArgumentResolver

public HateoasPageableHandlerMethodArgumentResolver()

Constructs an instance of this resolver with a default HateoasSortHandlerMethodArgumentResolver.

HateoasPageableHandlerMethodArgumentResolver

public HateoasPageableHandlerMethodArgumentResolver(HateoasSortHandlerMethodArgumentResolver sortResolver)

Creates a new HateoasPageableHandlerMethodArgumentResolver using the given HateoasSortHandlerMethodArgumentResolver..

Parameters:

sortResolver -

Method Detail

getPaginationTemplateVariables

public org.springframework.hateoas.TemplateVariables getPaginationTemplateVariables(MethodParameter parameter,
                                                                           UriComponents template)

Returns the template variable for the pagination parameters.

Parameters:

parameter - can be null.

Returns:

Since:

1.7

enhance

public void enhance(UriComponentsBuilder builder,
           MethodParameter parameter,
           Object value)

Specified by:

enhance in interface org.springframework.hateoas.mvc.UriComponentsContributor