org.springframework.cloud.openfeign.support

Class PageableSpringEncoder

java.lang.Object

org.springframework.cloud.openfeign.support.PageableSpringEncoder

All Implemented Interfaces:

feign.codec.Encoder

public class PageableSpringEncoder
extends Object
implements feign.codec.Encoder

Provides support for encoding spring Pageable via composition.

Author:

Pascal Büttiker, Yanming Zhou

Nested Class Summary

Nested classes/interfaces inherited from interface feign.codec.Encoder

feign.codec.Encoder.Default

Field Summary

Fields inherited from interface feign.codec.Encoder

MAP_STRING_WILDCARD

Constructor Summary

Constructors

Constructor and Description
PageableSpringEncoder(feign.codec.Encoder delegate) Creates a new PageableSpringEncoder with the given delegate for fallback.

Method Summary

Modifier and Type	Method and Description
void	encode(Object object, Type bodyType, feign.RequestTemplate template)
void	setPageParameter(String pageParameter)
void	setSizeParameter(String sizeParameter)
void	setSortParameter(String sortParameter)
protected boolean	supports(Object object)

Methods inherited from class java.lang.Object

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

Constructor Detail

PageableSpringEncoder

public PageableSpringEncoder(feign.codec.Encoder delegate)

Creates a new PageableSpringEncoder with the given delegate for fallback. If no delegate is provided and this encoder cant handle the request, an EncodeException is thrown.

Parameters:

delegate - The optional delegate.

Method Detail

setPageParameter

public void setPageParameter(String pageParameter)

setSizeParameter

public void setSizeParameter(String sizeParameter)

setSortParameter

public void setSortParameter(String sortParameter)

encode

public void encode(Object object,
                   Type bodyType,
                   feign.RequestTemplate template)
            throws feign.codec.EncodeException

Specified by:

encode in interface feign.codec.Encoder

Throws:

feign.codec.EncodeException

supports

protected boolean supports(Object object)