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.ObjectConfiguration for pageable.
-
-
Field Summary
Fields Modifier and Type Field Description static intDEFAULT_MAX_PAGE_SIZEstatic java.lang.StringDEFAULT_PAGE_PARAMETERstatic java.lang.StringDEFAULT_SIZE_PARAMETERstatic booleanDEFAULT_SORT_IGNORE_CASEstatic java.lang.StringDEFAULT_SORT_PARAMETERstatic java.lang.StringPREFIX
-
Constructor Summary
Constructors Constructor Description PageableConfiguration()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intgetDefaultPageSize()intgetMaxPageSize()java.lang.StringgetPageParameterName()java.lang.StringgetSizeParameterName()java.util.regex.PatterngetSortDelimiterPattern()java.lang.StringgetSortParameterName()booleanisSortIgnoreCase()voidsetDefaultPageSize(int defaultPageSize)Sets the default page size when bindingPageableobjects and no size parameter is used.voidsetMaxPageSize(int maxPageSize)Sets the maximum page size when bindingPageableobjects.voidsetPageParameterName(java.lang.String pageParameterName)voidsetSizeParameterName(java.lang.String sizeParameterName)voidsetSortDelimiter(java.lang.String sortDelimiter)voidsetSortIgnoreCase(boolean sortIgnoreCase)voidsetSortParameterName(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
Pageableobjects.
-
setMaxPageSize
public void setMaxPageSize(int maxPageSize)
Sets the maximum page size when bindingPageableobjects.- Parameters:
maxPageSize- The max page size
-
getDefaultPageSize
public int getDefaultPageSize()
- Returns:
- the page size to use when binding
Pageableobjects 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 bindingPageableobjects 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
-
-