Page (pagehelper 5 5.3.3 API)

java.lang.Object
- java.util.AbstractCollection<E>
- - java.util.AbstractList<E>
  - - java.util.ArrayList<E>
    - - com.github.pagehelper.Page<E>

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, Cloneable, Iterable<E>, Collection<E>, List<E>, RandomAccess
```
public class Page<E>
extends ArrayList<E>
implements Closeable
```
Mybatis - 分页对象

Version:

3.6.0 项目地址 : http://git.oschina.net/free/Mybatis_PageHelper

Author:

liuzh/abel533/isea533

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Page.Function<E,T>
兼容低版本 Java 7-

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Page.Function<E,T>` 兼容低版本 Java 7-

Field Summary
- Fields inherited from class java.util.AbstractList
  modCount

Constructor Summary

Constructors
Constructor and Description
`Page()`
`Page(int[] rowBounds, boolean count)` int[] rowBounds 0 : offset 1 : limit
`Page(int pageNum, int pageSize)`
`Page(int pageNum, int pageSize, boolean count)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Page<E>`	`boundSqlInterceptor(BoundSqlInterceptor boundSqlInterceptor)` 设置 BoundSql 拦截器
`void`	`close()`
`Page<E>`	`count(Boolean count)` 是否执行count查询
`Page<E>`	`countColumn(String columnName)` 指定 count 查询列
`long`	`doCount(ISelect select)`
`<E> Page<E>`	`doSelectPage(ISelect select)`
`<E> PageInfo<E>`	`doSelectPageInfo(ISelect select)`
`<E> PageSerializable<E>`	`doSelectPageSerializable(ISelect select)`
`BoundSqlInterceptor`	`getBoundSqlInterceptor()`
`String`	`getCountColumn()`
`String`	`getDialectClass()`
`long`	`getEndRow()`
`Boolean`	`getKeepOrderBy()`
`Boolean`	`getKeepSubSelectOrderBy()`
`String`	`getOrderBy()`
`int`	`getPageNum()`
`int`	`getPages()`
`int`	`getPageSize()`
`Boolean`	`getPageSizeZero()`
`Boolean`	`getReasonable()`
`List<E>`	`getResult()`
`String`	`getStackTrace()`
`long`	`getStartRow()`
`long`	`getTotal()`
`boolean`	`isCount()`
`boolean`	`isOrderByOnly()`
`boolean`	`keepOrderBy()`
`Page<E>`	`keepOrderBy(boolean keepOrderBy)` 转换count查询时保留查询的 order by 排序
`boolean`	`keepSubSelectOrderBy()`
`Page<E>`	`keepSubSelectOrderBy(boolean keepSubSelectOrderBy)` 转换count查询时保留子查询的 order by 排序
`Page<E>`	`pageNum(int pageNum)` 设置页码
`Page<E>`	`pageSize(int pageSize)` 设置页面大小
`Page<E>`	`pageSizeZero(Boolean pageSizeZero)` 当设置为true的时候，如果pagesize设置为0（或RowBounds的limit=0），就不执行分页，返回全部结果
`Page<E>`	`reasonable(Boolean reasonable)` 设置合理化
`void`	`setBoundSqlInterceptor(BoundSqlInterceptor boundSqlInterceptor)`
`Page<E>`	`setCount(boolean count)`
`void`	`setCountColumn(String countColumn)`
`void`	`setDialectClass(String dialectClass)`
`Page<E>`	`setEndRow(long endRow)`
`Page<E>`	`setKeepOrderBy(Boolean keepOrderBy)`
`void`	`setKeepSubSelectOrderBy(Boolean keepSubSelectOrderBy)`
`<E> Page<E>`	`setOrderBy(String orderBy)` 设置排序字段，增加 SQL 注入校验，如果需要在 order by 使用函数，可以使用 `setUnsafeOrderBy(String)` 方法
`void`	`setOrderByOnly(boolean orderByOnly)`
`Page<E>`	`setPageNum(int pageNum)`
`Page<E>`	`setPages(int pages)`
`Page<E>`	`setPageSize(int pageSize)`
`Page<E>`	`setPageSizeZero(Boolean pageSizeZero)`
`Page<E>`	`setReasonable(Boolean reasonable)`
`Page<E>`	`setStartRow(long startRow)`
`void`	`setTotal(long total)`
`<E> Page<E>`	`setUnsafeOrderBy(String orderBy)` 不安全的设置排序方法，如果从前端接收参数，请自行做好注入校验。
`PageInfo<E>`	`toPageInfo()`
`<T> PageInfo<T>`	`toPageInfo(Page.Function<E,T> function)` 数据对象转换
`PageSerializable<E>`	`toPageSerializable()`
`<T> PageSerializable<T>`	`toPageSerializable(Page.Function<E,T> function)` 数据对象转换
`String`	`toString()`
`Page<E>`	`using(String dialect)` 指定使用的分页实现，如果自己使用的很频繁，建议自己增加一层封装再使用

Methods inherited from class java.util.ArrayList
add, add, addAll, addAll, clear, clone, contains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList
equals, hashCode

Methods inherited from class java.util.AbstractCollection
containsAll

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

Methods inherited from interface java.util.List
containsAll, equals, hashCode

Methods inherited from interface java.util.Collection
parallelStream, stream

Constructor Detail

Page
```
public Page()
```

Page

public Page(int pageNum,
            int pageSize)

Page

public Page(int pageNum,
            int pageSize,
            boolean count)

Page

public Page(int[] rowBounds,
            boolean count)

int[] rowBounds 0 : offset 1 : limit

Method Detail

getStackTrace
```
public String getStackTrace()
```

getResult
```
public List<E> getResult()
```

getPages
```
public int getPages()
```

setPages
```
public Page<E> setPages(int pages)
```

getEndRow
```
public long getEndRow()
```

setEndRow

public Page<E> setEndRow(long endRow)

getPageNum
```
public int getPageNum()
```

setPageNum

public Page<E> setPageNum(int pageNum)

getPageSize
```
public int getPageSize()
```

setPageSize

public Page<E> setPageSize(int pageSize)

getStartRow
```
public long getStartRow()
```

setStartRow

public Page<E> setStartRow(long startRow)

getTotal
```
public long getTotal()
```

setTotal
```
public void setTotal(long total)
```

getReasonable
```
public Boolean getReasonable()
```

setReasonable

public Page<E> setReasonable(Boolean reasonable)

getPageSizeZero
```
public Boolean getPageSizeZero()
```

setPageSizeZero

public Page<E> setPageSizeZero(Boolean pageSizeZero)

getOrderBy
```
public String getOrderBy()
```

setOrderBy
```
public <E> Page<E> setOrderBy(String orderBy)
```
设置排序字段，增加 SQL 注入校验，如果需要在 order by 使用函数，可以使用 setUnsafeOrderBy(String) 方法

Parameters:

orderBy - 排序字段

setUnsafeOrderBy
```
public <E> Page<E> setUnsafeOrderBy(String orderBy)
```
不安全的设置排序方法，如果从前端接收参数，请自行做好注入校验。
请不要故意使用该方法注入然后提交漏洞!!!

Parameters:

orderBy - 排序字段

isOrderByOnly
```
public boolean isOrderByOnly()
```

setOrderByOnly

public void setOrderByOnly(boolean orderByOnly)

getDialectClass
```
public String getDialectClass()
```

setDialectClass

public void setDialectClass(String dialectClass)

getKeepOrderBy
```
public Boolean getKeepOrderBy()
```

setKeepOrderBy

public Page<E> setKeepOrderBy(Boolean keepOrderBy)

getKeepSubSelectOrderBy

public Boolean getKeepSubSelectOrderBy()

setKeepSubSelectOrderBy

public void setKeepSubSelectOrderBy(Boolean keepSubSelectOrderBy)

using
```
public Page<E> using(String dialect)
```
指定使用的分页实现，如果自己使用的很频繁，建议自己增加一层封装再使用

Parameters:

dialect - 分页实现类，可以使用 PageAutoDialect 类中注册的别名，例如 "mysql", "oracle"

Returns:

isCount
```
public boolean isCount()
```

setCount

public Page<E> setCount(boolean count)

pageNum
```
public Page<E> pageNum(int pageNum)
```
设置页码

Parameters:

pageNum -

Returns:

pageSize
```
public Page<E> pageSize(int pageSize)
```
设置页面大小

Parameters:

pageSize -

Returns:

count
```
public Page<E> count(Boolean count)
```
是否执行count查询

Parameters:

count -

Returns:

reasonable
```
public Page<E> reasonable(Boolean reasonable)
```
设置合理化

Parameters:

reasonable -

Returns:

pageSizeZero
```
public Page<E> pageSizeZero(Boolean pageSizeZero)
```
当设置为true的时候，如果pagesize设置为0（或RowBounds的limit=0），就不执行分页，返回全部结果

Parameters:

pageSizeZero -

Returns:

boundSqlInterceptor
```
public Page<E> boundSqlInterceptor(BoundSqlInterceptor boundSqlInterceptor)
```
设置 BoundSql 拦截器

Parameters:

boundSqlInterceptor -

Returns:

countColumn
```
public Page<E> countColumn(String columnName)
```
指定 count 查询列

Parameters:

columnName -

Returns:

keepOrderBy
```
public Page<E> keepOrderBy(boolean keepOrderBy)
```
转换count查询时保留查询的 order by 排序

Parameters:

keepOrderBy -

Returns:

keepOrderBy
```
public boolean keepOrderBy()
```

keepSubSelectOrderBy
```
public Page<E> keepSubSelectOrderBy(boolean keepSubSelectOrderBy)
```
转换count查询时保留子查询的 order by 排序

Parameters:

keepSubSelectOrderBy -

Returns:

keepSubSelectOrderBy
```
public boolean keepSubSelectOrderBy()
```

toPageInfo
```
public PageInfo<E> toPageInfo()
```

toPageInfo
```
public <T> PageInfo<T> toPageInfo(Page.Function<E,T> function)
```
数据对象转换

Type Parameters:

T -

Parameters:

function -

Returns:

toPageSerializable

public PageSerializable<E> toPageSerializable()

toPageSerializable

public <T> PageSerializable<T> toPageSerializable(Page.Function<E,T> function)

数据对象转换

Type Parameters:: T -
Parameters:: function -
Returns:

doSelectPage

public <E> Page<E> doSelectPage(ISelect select)

doSelectPageInfo

public <E> PageInfo<E> doSelectPageInfo(ISelect select)

doSelectPageSerializable

public <E> PageSerializable<E> doSelectPageSerializable(ISelect select)

doCount
```
public long doCount(ISelect select)
```

getCountColumn
```
public String getCountColumn()
```

setCountColumn

public void setCountColumn(String countColumn)

getBoundSqlInterceptor

public BoundSqlInterceptor getBoundSqlInterceptor()

setBoundSqlInterceptor

public void setBoundSqlInterceptor(BoundSqlInterceptor boundSqlInterceptor)

toString
```
public String toString()
```
Overrides:

toString in class AbstractCollection<E>

close
```
public void close()
```
Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Class Page<E>

Nested Class Summary

Field Summary

Fields inherited from class java.util.AbstractList

Constructor Summary

Method Summary

Methods inherited from class java.util.ArrayList

Methods inherited from class java.util.AbstractList

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.List

Methods inherited from interface java.util.Collection

Constructor Detail

Page

Page

Page

Page

Method Detail

getStackTrace

getResult

getPages

setPages

getEndRow

setEndRow

getPageNum

setPageNum

getPageSize

setPageSize

getStartRow

setStartRow

getTotal

setTotal

getReasonable

setReasonable

getPageSizeZero

setPageSizeZero

getOrderBy

setOrderBy

setUnsafeOrderBy

isOrderByOnly

setOrderByOnly

getDialectClass

setDialectClass

getKeepOrderBy

setKeepOrderBy

getKeepSubSelectOrderBy

setKeepSubSelectOrderBy

using

isCount

setCount

pageNum

pageSize

count

reasonable

pageSizeZero

boundSqlInterceptor

countColumn

keepOrderBy

keepOrderBy

keepSubSelectOrderBy

keepSubSelectOrderBy

toPageInfo

toPageInfo

toPageSerializable

toPageSerializable

doSelectPage

doSelectPageInfo

doSelectPageSerializable

doCount

getCountColumn

setCountColumn

getBoundSqlInterceptor

setBoundSqlInterceptor

toString

close