@Introspected public interface Pageable extends Sort
from(int, int)
method can be used to construct a new instance to pass to Micronaut Data methods.Sort.Order
Modifier and Type | Field and Description |
---|---|
static Pageable |
UNPAGED
Constant for no pagination.
|
Modifier and Type | Method and Description |
---|---|
static Pageable |
from(int page)
Creates a new
Pageable at the given offset with a default size of 10. |
static Pageable |
from(int page,
int size)
Creates a new
Pageable at the given offset. |
static Pageable |
from(int page,
int size,
Sort sort)
Creates a new
Pageable at the given offset. |
static Pageable |
from(Sort sort)
Creates a new
Pageable at the given offset. |
int |
getNumber() |
default long |
getOffset()
Offset in the requested collection.
|
default java.util.List<Sort.Order> |
getOrderBy() |
int |
getSize()
Maximum size of the page to be returned.
|
default Sort |
getSort() |
default boolean |
isSorted() |
default Pageable |
next() |
default Pageable |
order(Sort.Order order)
Adds an order object.
|
default Pageable |
order(java.lang.String propertyName)
Orders by the specified property name (defaults to ascending).
|
default Pageable |
order(java.lang.String propertyName,
Sort.Order.Direction direction)
Orders by the specified property name and direction.
|
default Pageable |
previous() |
static Pageable |
unpaged() |
static final Pageable UNPAGED
int getNumber()
int getSize()
default long getOffset()
@NonNull default Sort getSort()
@NonNull default Pageable next()
@NonNull default Pageable previous()
@NonNull default Pageable order(@NonNull java.lang.String propertyName)
Sort
default boolean isSorted()
@NonNull default Pageable order(@NonNull Sort.Order order)
Sort
@NonNull default Pageable order(@NonNull java.lang.String propertyName, @NonNull Sort.Order.Direction direction)
Sort
@NonNull default java.util.List<Sort.Order> getOrderBy()
getOrderBy
in interface Sort
@NonNull static Pageable from(int page)
Pageable
at the given offset with a default size of 10.page
- The page@NonNull static Pageable from(int page, int size)
Pageable
at the given offset.page
- The pagesize
- the size@NonNull static Pageable from(int page, int size, @Nullable Sort sort)
Pageable
at the given offset.page
- The pagesize
- the sizesort
- the sort@NonNull static Pageable from(Sort sort)
Pageable
at the given offset.sort
- the sort@NonNull static Pageable unpaged()