PageInfo (hutool 6.0.0-M20 API)

java.lang.Object
- org.dromara.hutool.core.lang.page.PageInfo

Direct Known Subclasses:

NavigatePageInfo
```
public class PageInfo
extends Object
```
分页信息，通过提供的总数、页码、每页记录数等信息，计算总页数等信息
来自：https://bbs.csdn.net/topics/360010907

Author:

莫取网名

Constructor Summary

Constructors
Constructor and Description

PageInfo(int total, int pageSize)
构造

Constructors
Constructor and Description
`PageInfo(int total, int pageSize)` 构造

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getBeginIndex()` 获取当前页的开始记录index（包含）
`int`	`getEndIndex()` 获取当前页的结束记录index（包含）当开始index超出total时，返回正常值当开始index未超出total但是计算的end超出时，返回total 当开始index和end都未超出时，返回正常值
`int`	`getEndIndexExclude()` 获取当前页的结束记录index（不包含）当开始index超出total时，返回正常值当开始index未超出total但是计算的end超出时，返回total + 1 当开始index和end都未超出时，返回正常值
`int`	`getFirstPageNo()` 获取设置首页编号，即以数字几为第一页标志
`int`	`getPageCount()` 得到页面总数
`int`	`getPageNo()` 得到当前页号
`int`	`getPageSize()` 得到每页显示多少条记录
`Segment<Integer>`	`getSegment()` 将页数和每页条目数转换为开始位置和结束位置此方法用于包括结束位置的分页方法例如：页码：1，每页10 =》 [0, 9] 页码：2，每页10 =》 [10, 19] ……
`int`	`getTotal()` 得到记录总数
`boolean`	`hasNextPage()` 是否有下一页
`boolean`	`hasPreviousPage()` 是否有前一页
`boolean`	`isFirstPage()` 是否首页
`boolean`	`isLastPage()` 是否尾页
`boolean`	`isValidPage()` 当前页是否可用（是否大于firstPageNum且小于总页数）
`PageInfo`	`nextPage()` 下一页，即当前页码+1 当超过末页时，此方法指向的页码值始终为`getPageCount()` + 1，即最后一页后的空白页。
`static PageInfo`	`of(int total, int pageSize)` 创建`PageInfo`，默认当前页是1
`PageInfo`	`previousPage()` 上一页，即当前页码-1,直到第一页则始终为第一页
`PageInfo`	`setFirstPageNo(int firstPageNo)` 设置首页编号，即以数字几为第一页标志如设置0，则0表示第一页，1表示第二页设置此参数后，须调用`setPageNo(int)` 重新设置当前页的页码
`PageInfo`	`setPageNo(int pageNo)` 设置当前页码，具体这个页码代表实际页，取决于`setFirstPageNo(int)`设置的值。
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PageInfo
```
public PageInfo(int total,
                int pageSize)
```
    构造
    
    Parameters:
    
    total - 总记录数
    
    pageSize - 每页显示记录数
- Method Detail
  - of
```
public static PageInfo of(int total,
                          int pageSize)
```
    创建PageInfo，默认当前页是1
    
    Parameters:
    
    total - 总记录数
    
    pageSize - 每页显示记录数
    
    Returns:
    
    PageInfo
  - getTotal
```
public int getTotal()
```
    得到记录总数
    
    Returns:
    
    {int}
  - getPageSize
```
public int getPageSize()
```
    得到每页显示多少条记录
    
    Returns:
    
    {int}
  - getPageCount
```
public int getPageCount()
```
    得到页面总数
    
    Returns:
    
    {int}
  - getPageNo
```
public int getPageNo()
```
    得到当前页号
    
    Returns:
    
    {int}
  - isFirstPage
```
public boolean isFirstPage()
```
    是否首页
    
    Returns:
    
    是否首页
  - isLastPage
```
public boolean isLastPage()
```
    是否尾页
    
    Returns:
    
    是否尾页
  - hasPreviousPage
```
public boolean hasPreviousPage()
```
    是否有前一页
    
    Returns:
    
    是否有前一页
  - hasNextPage
```
public boolean hasNextPage()
```
    是否有下一页
    
    Returns:
    
    是否有下一页
  - isValidPage
```
public boolean isValidPage()
```
    当前页是否可用（是否大于firstPageNum且小于总页数）
    
    Returns:
    
    是否可用
  - getBeginIndex
```
public int getBeginIndex()
```
    获取当前页的开始记录index（包含）
    
    Returns:
    
    开始记录index（包含）
  - getEndIndexExclude
```
public int getEndIndexExclude()
```
    获取当前页的结束记录index（不包含）
    - 当开始index超出total时，返回正常值
    - 当开始index未超出total但是计算的end超出时，返回total + 1
    - 当开始index和end都未超出时，返回正常值
    Returns:
    
    结束记录index（不包含）
  - getEndIndex
```
public int getEndIndex()
```
    获取当前页的结束记录index（包含）
    - 当开始index超出total时，返回正常值
    - 当开始index未超出total但是计算的end超出时，返回total
    - 当开始index和end都未超出时，返回正常值
    Returns:
    
    结束记录index（包含）
  - getSegment
```
public Segment<Integer> getSegment()
```
    将页数和每页条目数转换为开始位置和结束位置
    此方法用于包括结束位置的分页方法
    例如：
```
 页码：1，每页10 =》 [0, 9]
 页码：2，每页10 =》 [10, 19]
 ……
 
```
    Returns:
    
    Segment
  - getFirstPageNo
```
public int getFirstPageNo()
```
    获取设置首页编号，即以数字几为第一页标志
    
    Returns:
    
    设置首页编号
  - setFirstPageNo
```
public PageInfo setFirstPageNo(int firstPageNo)
```
    设置首页编号，即以数字几为第一页标志
    如设置0，则0表示第一页，1表示第二页
    设置此参数后，须调用setPageNo(int) 重新设置当前页的页码
    
    Parameters:
    
    firstPageNo - 首页编号
    
    Returns:
    
    this
  - setPageNo
```
public PageInfo setPageNo(int pageNo)
```
    设置当前页码，具体这个页码代表实际页，取决于setFirstPageNo(int)设置的值。例如当setFirstPageNo(int)设置为1时，1表示首页；设置为0时，0表示首页，依次类推。
    当设置页码小于getFirstPageNo()值时，始终为getFirstPageNo()
    
    Parameters:
    
    pageNo - 当前页码
    
    Returns:
    
    this
  - nextPage
```
public PageInfo nextPage()
```
    下一页，即当前页码+1
    当超过末页时，此方法指向的页码值始终为getPageCount() + 1，即最后一页后的空白页。
    
    Returns:
    
    this
  - previousPage
```
public PageInfo previousPage()
```
    上一页，即当前页码-1,直到第一页则始终为第一页
    
    Returns:
    
    this
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class PageInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PageInfo

Method Detail

of

getTotal

getPageSize

getPageCount

getPageNo

isFirstPage

isLastPage

hasPreviousPage

hasNextPage

isValidPage

getBeginIndex

getEndIndexExclude

getEndIndex

getSegment

getFirstPageNo

setFirstPageNo

setPageNo

nextPage

previousPage

toString