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 Object
Configuration for pageable.

  • Field Details

  • Constructor Details

    • PageableConfiguration

      public PageableConfiguration()

  • Method Details

    • isSortIgnoreCase

      public boolean isSortIgnoreCase()
      Returns:
      Whether sort ignores case.

    • setSortIgnoreCase

      public void setSortIgnoreCase(boolean sortIgnoreCase)
      Parameters:
      sortIgnoreCase - Whether sort ignores case

    • getSortDelimiterPattern

      public Pattern getSortDelimiterPattern()
      Returns:
      The delimiter to use to calculate sort order. Defaults to ,.

    • setSortDelimiter

      public void setSortDelimiter(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 binding Pageable 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 as maxPageSize

    • setDefaultPageSize

      public void setDefaultPageSize(int defaultPageSize)
      Sets the default page size when binding Pageable objects and no size parameter is used. Should be smaller or equal than maxPageSize.
      Parameters:
      defaultPageSize - The default page size

    • getSortParameterName

      public String getSortParameterName()
      Returns:
      The default sort parameter name

    • setSortParameterName

      public void setSortParameterName(String sortParameterName)
      Parameters:
      sortParameterName - The default sort parameter name

    • getSizeParameterName

      public String getSizeParameterName()
      Returns:
      The default size parameter name

    • setSizeParameterName

      public void setSizeParameterName(String sizeParameterName)
      Parameters:
      sizeParameterName - The default size parameter name

    • getPageParameterName

      public String getPageParameterName()
      Returns:
      The default page parameter name

    • setPageParameterName

      public void setPageParameterName(String pageParameterName)
      Parameters:
      pageParameterName - Sets the default page parameter name