public class PageResult<E> extends R<Collection<E>> implements Iterable<E>
It is not recommended to change the page data after construction. page - 1-based, not less than 1. size - 1-based, not less than 1. sort - sort string totalPage - 1-based, not less than 1, calculated by data and size totalData - 0-based, not less than 0, not more than 2.1 billion. meta - in addition to data information.
R.Immutable<T>| Constructor and Description |
|---|
PageResult() |
| Modifier and Type | Method and Description |
|---|---|
PageResult<E> |
addData(Collection<E> ds) |
PageResult<E> |
addData(E e) |
PageResult<E> |
addMeta(String key,
Object value) |
static <T> PageResult<T> |
empty()
constructor an empty page result of total is 0, size is 1.
|
boolean |
equals(Object o) |
@NotNull Collection<E> |
getData()
the biz data to caller
|
Map<String,?> |
getMeta() |
<T> T |
getMeta(String key) |
int |
getPage()
current page, 1-based, not less than 1.
|
int |
getSize()
page size, 1-based, not less than 1.
|
@Nullable String |
getSort()
Sorting String
|
int |
getTotalData()
0-based, not less than 0, not more than 2.1 billion.
|
int |
getTotalPage()
1-based, not less than 1, calculated by data and size.
|
boolean |
hasData()
whether valid data, null mean false.
|
int |
hashCode() |
<T> PageResult<T> |
into(Function<E,T> fun) |
@NotNull Iterator<E> |
iterator() |
static <T> PageResult<T> |
ok(int total,
Collection<T> data,
int page,
int size)
constructor
|
static <T> PageResult<T> |
ok(int total,
Collection<T> data,
PageQuery pg)
constructor
|
PageResult<E> |
setCause(Object cause) |
R<Collection<E>> |
setCode(CodeEnum code) |
PageResult<E> |
setCode(String code) |
PageResult<E> |
setData(Collection<E> ds) |
PageResult<E> |
setI18nMessage(CodeEnum ce,
Object... arg)
set i18nCode and i18nArgs.
|
PageResult<E> |
setI18nMessage(I18nAware message)
set i18nCode and i18nArgs.
|
PageResult<E> |
setI18nMessage(String i18nCode,
Object... args) |
PageResult<E> |
setMessage(String message) |
PageResult<E> |
setMeta(Map<String,Object> meta) |
PageResult<E> |
setPage(int page) |
void |
setSize(int size) |
PageResult<E> |
setSort(String sort)
Sorting String
|
PageResult<E> |
setSuccess(boolean success) |
void |
setTotalData(int totalData) |
PageResult<E> |
setTotalInfo(int totalData,
int pageSize)
Set the total data and page size, then calculate the total page
|
void |
setTotalPage(int totalPage) |
@NotNull List<E> |
toList() |
String |
toString() |
castData, castData, castType, getCause, getCause, getCode, getI18nArgs, getI18nCode, getI18nHint, getMessage, isSuccess, ng, NG, ng, ng, ng, ng, ng, ng, ng, ng, ng, ng, ng, ng, ng, ng, ng, ng, ng, ng, ng, ngCode, ngCode, ngCode, ngCode, ngCode, ngCode, ngData, ngData, ngData, ngData, ngData, ngData, ngData, ngData, of, of, of, of, of, of, of, ok, OK, ok, ok, ok, ok, ok, okCode, okCode, okCode, okData, okData, orCode, orCode, orData, orMessage, setCodeIfNg, setCodeIfNg, setCodeIfNg, setCodeIfOk, setCodeIfOk, setCodeIfOk, setDataIfNg, setDataIfNg, setDataIfOk, setDataIfOk, setI18nMessage, setI18nMessage, setI18nMessageIfNg, setI18nMessageIfNg, setI18nMessageIfNg, setI18nMessageIfNg, setI18nMessageIfNg, setI18nMessageIfNg, setI18nMessageIfNg, setI18nMessageIfOk, setI18nMessageIfOk, setI18nMessageIfOk, setI18nMessageIfOk, setI18nMessageIfOk, setI18nMessageIfOk, setI18nMessageIfOk, setMessageIfNg, setMessageIfNg, setMessageIfOk, setMessageIfOkclone, finalize, getClass, notify, notifyAll, wait, wait, waitforEach, spliteratorhasMessagetoI18nString, toI18nString, toI18nString, toI18nStringArgspublic int getPage()
@Contract(value="_->this") public PageResult<E> setPage(int page)
public int getSize()
public void setSize(int size)
@Nullable public @Nullable String getSort()
PageUtil.sort(String)@Contract(value="_->this") public PageResult<E> setSort(String sort)
sort - Sorting stringPageUtil.sort(String)public int getTotalPage()
public void setTotalPage(int totalPage)
public int getTotalData()
public void setTotalData(int totalData)
@Contract(value="_,_->this") public PageResult<E> setTotalInfo(int totalData, int pageSize)
totalData - total countpageSize - page size@Contract(value="_->this") public PageResult<E> setData(Collection<E> ds)
setData in class R<Collection<E>>@NotNull public @NotNull Collection<E> getData()
DataResultgetData in interface DataResult<Collection<E>>getData in class R<Collection<E>>@Contract(value="_->this") public PageResult<E> setSuccess(boolean success)
setSuccess in class R<Collection<E>>@Contract(value="_->this") public PageResult<E> setMessage(String message)
setMessage in class R<Collection<E>>@Contract(value="_,_->this") public PageResult<E> setI18nMessage(CodeEnum ce, Object... arg)
RsetI18nMessage in class R<Collection<E>>@Contract(value="_->this") public PageResult<E> setI18nMessage(I18nAware message)
RsetI18nMessage in class R<Collection<E>>@Contract(value="_,_->this") public PageResult<E> setI18nMessage(String i18nCode, Object... args)
setI18nMessage in class R<Collection<E>>@Contract(value="_->this") public PageResult<E> setCode(String code)
setCode in class R<Collection<E>>@Contract(value="_->this") public R<Collection<E>> setCode(CodeEnum code)
setCode in class R<Collection<E>>@Contract(value="_->this") public PageResult<E> setCause(Object cause)
setCause in class R<Collection<E>>@Contract(value="_->this") public PageResult<E> addData(E e)
@Contract(value="_->this") public PageResult<E> addData(Collection<E> ds)
public boolean hasData()
DataResulthasData in interface DataResult<Collection<E>>@Contract(value="_->this") public PageResult<E> setMeta(Map<String,Object> meta)
@Contract(value="_,_->this") public PageResult<E> addMeta(String key, Object value)
public <T> T getMeta(String key)
public <T> PageResult<T> into(Function<E,T> fun)
public String toString()
toString in class R<Collection<E>>public boolean equals(Object o)
equals in class R<Collection<E>>public int hashCode()
hashCode in class R<Collection<E>>public static <T> PageResult<T> ok(int total, Collection<T> data, PageQuery pg)
T - data typetotal - total data countdata - current page of datapg - query of pagepublic static <T> PageResult<T> ok(int total, Collection<T> data, int page, int size)
T - data typetotal - total data countdata - current page of datapage - current pagesize - page sizepublic static <T> PageResult<T> empty()
Copyright © 2024. All rights reserved.