java.lang.Object
- io.github.jhipster.config.apidoc.PageableParameterBuilderPlugin

All Implemented Interfaces:

org.springframework.plugin.core.Plugin<springfox.documentation.spi.DocumentationType>, springfox.documentation.spi.service.OperationBuilderPlugin
```
public class PageableParameterBuilderPlugin
extends Object
implements springfox.documentation.spi.service.OperationBuilderPlugin
```
The Springfox Plugin to resolve Pageable parameter into plain fields.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`DEFAULT_PAGE_NAME`	Constant `DEFAULT_PAGE_NAME="page"`
`static String`	`DEFAULT_SIZE_NAME`	Constant `DEFAULT_SIZE_NAME="size"`
`static String`	`DEFAULT_SORT_NAME`	Constant `DEFAULT_SORT_NAME="sort"`
`static String`	`PAGE_DESCRIPTION`	Constant `PAGE_DESCRIPTION="Page number of the requested page"`
`static String`	`PAGE_TYPE`	Constant `PAGE_TYPE="query"`
`static String`	`SIZE_DESCRIPTION`	Constant `SIZE_DESCRIPTION="Size of a page"`
`static String`	`SIZE_TYPE`	Constant `SIZE_TYPE="query"`
`static String`	`SORT_DESCRIPTION`	Constant `SORT_DESCRIPTION="Sorting criteria in the format: propert"{trunked}`
`static String`	`SORT_TYPE`	Constant `SORT_TYPE="query"`

Constructor Summary

Constructors
Constructor	Description
`PageableParameterBuilderPlugin(springfox.documentation.schema.TypeNameExtractor nameExtractor, com.fasterxml.classmate.TypeResolver resolver)`	Constructor for PageableParameterBuilderPlugin.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`apply(springfox.documentation.spi.service.contexts.OperationContext context)`
`protected Function<com.fasterxml.classmate.ResolvedType,? extends springfox.documentation.schema.ModelReference>`	`createModelRefFactory(springfox.documentation.spi.service.contexts.ParameterContext context)`	createModelRefFactory.
`protected springfox.documentation.service.Parameter`	`createPageParameter(springfox.documentation.spi.service.contexts.ParameterContext context)`	Create a page parameter.
`protected springfox.documentation.service.Parameter`	`createSizeParameter(springfox.documentation.spi.service.contexts.ParameterContext context)`	Create a size parameter.
`protected springfox.documentation.service.Parameter`	`createSortParameter(springfox.documentation.spi.service.contexts.ParameterContext context)`	Create a sort parameter.
`protected String`	`getPageName()`	Page name may be varied.
`protected String`	`getSizeName()`	Size name may be varied.
`protected String`	`getSortName()`	Sort name may be varied.
`boolean`	`supports(springfox.documentation.spi.DocumentationType delimiter)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_PAGE_NAME
```
public static final String DEFAULT_PAGE_NAME
```
    Constant DEFAULT_PAGE_NAME="page"
    
    See Also:
    
    Constant Field Values
  - PAGE_TYPE
```
public static final String PAGE_TYPE
```
    Constant PAGE_TYPE="query"
    
    See Also:
    
    Constant Field Values
  - PAGE_DESCRIPTION
```
public static final String PAGE_DESCRIPTION
```
    Constant PAGE_DESCRIPTION="Page number of the requested page"
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SIZE_NAME
```
public static final String DEFAULT_SIZE_NAME
```
    Constant DEFAULT_SIZE_NAME="size"
    
    See Also:
    
    Constant Field Values
  - SIZE_TYPE
```
public static final String SIZE_TYPE
```
    Constant SIZE_TYPE="query"
    
    See Also:
    
    Constant Field Values
  - SIZE_DESCRIPTION
```
public static final String SIZE_DESCRIPTION
```
    Constant SIZE_DESCRIPTION="Size of a page"
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SORT_NAME
```
public static final String DEFAULT_SORT_NAME
```
    Constant DEFAULT_SORT_NAME="sort"
    
    See Also:
    
    Constant Field Values
  - SORT_TYPE
```
public static final String SORT_TYPE
```
    Constant SORT_TYPE="query"
    
    See Also:
    
    Constant Field Values
  - SORT_DESCRIPTION
```
public static final String SORT_DESCRIPTION
```
    Constant SORT_DESCRIPTION="Sorting criteria in the format: propert"{trunked}
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PageableParameterBuilderPlugin
```
public PageableParameterBuilderPlugin(springfox.documentation.schema.TypeNameExtractor nameExtractor,
                                      com.fasterxml.classmate.TypeResolver resolver)
```
    Constructor for PageableParameterBuilderPlugin.
    
    Parameters:
    
    nameExtractor - a TypeNameExtractor object.
    
    resolver - a TypeResolver object.
- Method Detail
  - supports
```
public boolean supports(springfox.documentation.spi.DocumentationType delimiter)
```
    Specified by:
    
    supports in interface org.springframework.plugin.core.Plugin<springfox.documentation.spi.DocumentationType>
  - apply
```
public void apply(springfox.documentation.spi.service.contexts.OperationContext context)
```
    Specified by:
    
    apply in interface springfox.documentation.spi.service.OperationBuilderPlugin
  - getPageName
```
protected String getPageName()
```
    Page name may be varied. See PageableHandlerMethodArgumentResolverSupport.setPageParameterName(String)
    
    Returns:
    
    The page parameter name
  - getSizeName
```
protected String getSizeName()
```
    Size name may be varied. See PageableHandlerMethodArgumentResolverSupport.setSizeParameterName(String)
    
    Returns:
    
    The size parameter name
  - getSortName
```
protected String getSortName()
```
    Sort name may be varied. See SortHandlerMethodArgumentResolverSupport.setSortParameter(String)
    
    Returns:
    
    The sort parameter name
  - createPageParameter
```
protected springfox.documentation.service.Parameter createPageParameter(springfox.documentation.spi.service.contexts.ParameterContext context)
```
    Create a page parameter. Override it if needed. Set a default value for example.
    
    Parameters:
    
    context - Pageable parameter context
    
    Returns:
    
    The page parameter
  - createSizeParameter
```
protected springfox.documentation.service.Parameter createSizeParameter(springfox.documentation.spi.service.contexts.ParameterContext context)
```
    Create a size parameter. Override it if needed. Set a default value for example.
    
    Parameters:
    
    context - Pageable parameter context
    
    Returns:
    
    The size parameter
  - createSortParameter
```
protected springfox.documentation.service.Parameter createSortParameter(springfox.documentation.spi.service.contexts.ParameterContext context)
```
    Create a sort parameter. Override it if needed. Set a default value or further description for example.
    
    Parameters:
    
    context - Pageable parameter context
    
    Returns:
    
    The sort parameter
  - createModelRefFactory
```
protected Function<com.fasterxml.classmate.ResolvedType,? extends springfox.documentation.schema.ModelReference> createModelRefFactory(springfox.documentation.spi.service.contexts.ParameterContext context)
```
    createModelRefFactory.
    
    Parameters:
    
    context - a ParameterContext object.
    
    Returns:
    
    a Function object.

Class PageableParameterBuilderPlugin

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_PAGE_NAME

PAGE_TYPE

PAGE_DESCRIPTION

DEFAULT_SIZE_NAME

SIZE_TYPE

SIZE_DESCRIPTION

DEFAULT_SORT_NAME

SORT_TYPE

SORT_DESCRIPTION

Constructor Detail

PageableParameterBuilderPlugin

Method Detail

supports

apply

getPageName

getSizeName

getSortName

createPageParameter

createSizeParameter

createSortParameter

createModelRefFactory