Package io.micronaut.data.runtime.config
Class DataConfiguration.PageableConfiguration
- java.lang.Object
-
- io.micronaut.data.runtime.config.DataConfiguration.PageableConfiguration
-
- Enclosing class:
- DataConfiguration
@ConfigurationProperties("pageable") public static class DataConfiguration.PageableConfiguration extends java.lang.Object
Configuration for pageable.
-
-
Field Summary
Fields Modifier and Type Field Description static int
DEFAULT_MAX_PAGE_SIZE
static java.lang.String
DEFAULT_PAGE_PARAMETER
static java.lang.String
DEFAULT_SIZE_PARAMETER
static boolean
DEFAULT_SORT_IGNORE_CASE
static java.lang.String
DEFAULT_SORT_PARAMETER
static java.lang.String
PREFIX
-
Constructor Summary
Constructors Constructor Description PageableConfiguration()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getDefaultPageSize()
int
getMaxPageSize()
java.lang.String
getPageParameterName()
java.lang.String
getSizeParameterName()
java.util.regex.Pattern
getSortDelimiterPattern()
java.lang.String
getSortParameterName()
boolean
isSortIgnoreCase()
void
setDefaultPageSize(int defaultPageSize)
Sets the default page size when bindingPageable
objects and no size parameter is used.void
setMaxPageSize(int maxPageSize)
Sets the maximum page size when bindingPageable
objects.void
setPageParameterName(java.lang.String pageParameterName)
void
setSizeParameterName(java.lang.String sizeParameterName)
void
setSortDelimiter(java.lang.String sortDelimiter)
void
setSortIgnoreCase(boolean sortIgnoreCase)
void
setSortParameterName(java.lang.String sortParameterName)
-
-
-
Field Detail
-
DEFAULT_MAX_PAGE_SIZE
public static final int DEFAULT_MAX_PAGE_SIZE
- See Also:
- Constant Field Values
-
DEFAULT_SORT_IGNORE_CASE
public static final boolean DEFAULT_SORT_IGNORE_CASE
- See Also:
- Constant Field Values
-
DEFAULT_SORT_PARAMETER
public static final java.lang.String DEFAULT_SORT_PARAMETER
- See Also:
- Constant Field Values
-
DEFAULT_SIZE_PARAMETER
public static final java.lang.String DEFAULT_SIZE_PARAMETER
- See Also:
- Constant Field Values
-
DEFAULT_PAGE_PARAMETER
public static final java.lang.String DEFAULT_PAGE_PARAMETER
- See Also:
- Constant Field Values
-
PREFIX
public static final java.lang.String PREFIX
- See Also:
- Constant Field Values
-
-
Method Detail
-
isSortIgnoreCase
public boolean isSortIgnoreCase()
- Returns:
- Whether sort ignores case.
-
setSortIgnoreCase
public void setSortIgnoreCase(boolean sortIgnoreCase)
- Parameters:
sortIgnoreCase
- Whether sort ignores case
-
getSortDelimiterPattern
public java.util.regex.Pattern getSortDelimiterPattern()
- Returns:
- The delimiter to use to calculate sort order. Defaults to
,
.
-
setSortDelimiter
public void setSortDelimiter(java.lang.String sortDelimiter)
- Parameters:
sortDelimiter
- The delimiter to use to calculate sort order. Defaults to,
.
-
getMaxPageSize
public int getMaxPageSize()
- Returns:
- The maximum page size when binding
Pageable
objects.
-
setMaxPageSize
public void setMaxPageSize(int maxPageSize)
Sets the maximum page size when bindingPageable
objects.- Parameters:
maxPageSize
- The max page size
-
getDefaultPageSize
public int getDefaultPageSize()
- Returns:
- the page size to use when binding
Pageable
objects and no size parameter is used. By default is set to the same vale asmaxPageSize
-
setDefaultPageSize
public void setDefaultPageSize(int defaultPageSize)
Sets the default page size when bindingPageable
objects and no size parameter is used. Should be smaller or equal thanmaxPageSize
.- Parameters:
defaultPageSize
- The default page size
-
getSortParameterName
public java.lang.String getSortParameterName()
- Returns:
- The default sort parameter name
-
setSortParameterName
public void setSortParameterName(java.lang.String sortParameterName)
- Parameters:
sortParameterName
- The default sort parameter name
-
getSizeParameterName
public java.lang.String getSizeParameterName()
- Returns:
- The default size parameter name
-
setSizeParameterName
public void setSizeParameterName(java.lang.String sizeParameterName)
- Parameters:
sizeParameterName
- The default size parameter name
-
getPageParameterName
public java.lang.String getPageParameterName()
- Returns:
- The default page parameter name
-
setPageParameterName
public void setPageParameterName(java.lang.String pageParameterName)
- Parameters:
pageParameterName
- Sets the default page parameter name
-
-