Example (mybatis-mapper 1.2.2 API)

java.lang.Object
- io.mybatis.mapper.example.Example<T>

```
public class Example<T>
extends Object
```
通用的 Example 查询对象

Author:

liuzh

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Example.Criteria<T>`
`static class`	`Example.Criterion`
`protected static class`	`Example.GeneratedCriteria<T>`
`static class`	`Example.OrCriteria<T>`
`static class`	`Example.Order` 排序方式

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`distinct` 是否使用 distinct
`protected String`	`endSql` 结尾 SQL，添加到 SQL 最后，注意防止 SQL 注入
`protected String`	`orderByClause` 排序字段
`protected List<Example.Criteria<T>>`	`oredCriteria` 多组条件通过 OR 连接
`protected String`	`selectColumns` 指定查询列
`protected List<Example.Criterion>`	`setValues` 设置 update 时的 set 字段
`protected String`	`simpleSelectColumns` 指定查询列，不带 column As Alias 别名
`protected String`	`startSql` 起始 SQL，添加到 SQL 前，注意防止 SQL 注入

Constructor Summary

Constructors
Constructor and Description

Example()
默认构造方法，不允许Example查询条件为空，不能操作全库

Constructors
Constructor and Description
`Example()` 默认构造方法，不允许Example查询条件为空，不能操作全库

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` 清除所有设置
`Example.Criteria<T>`	`createCriteria()` 创建一组条件，第一次调用时添加到默认条件中
`protected Example.Criteria<T>`	`createCriteriaInternal()`
`String`	`getEndSql()` 获取结尾 SQL
`String`	`getOrderByClause()` 获取排序列
`List<Example.Criteria<T>>`	`getOredCriteria()` 获取所有条件
`String`	`getSelectColumns()` 获取查询列
`List<Example.Criterion>`	`getSetValues()` 获取 set 值
`String`	`getSimpleSelectColumns()` 获取查询列，不带 column As Alias 别名
`String`	`getStartSql()` 获取起始 SQL
`boolean`	`isDistinct()` 是否使用 distince
`boolean`	`isEmpty()` 查询条件是否为空
`Example.Criteria<T>`	`or()` or 一组条件
`void`	`or(Example.Criteria<T> criteria)` or 条件
`Example<T>`	`orderBy(Fn<T,Object> fn, Example.Order order)` 通过方法引用方式设置排序字段
`Example<T>`	`orderByAsc(Fn<T,Object>... fns)` 通过方法引用方式设置排序字段，升序排序
`Example<T>`	`orderByDesc(Fn<T,Object>... fns)` 通过方法引用方式设置排序字段，降序排序
`Example.OrCriteria<T>`	`orPart()` 创建一个 or条件片段（不追加到当前Example）
`Example<T>`	`selectColumns(Fn<T,Object>... fns)` 指定查询列
`Example<T>`	`set(Fn<T,Object> fn, Object value)` 设置更新字段和值
`Example<T>`	`set(String setSql)` 设置更新字段和值
`Example<T>`	`setDistinct(boolean distinct)` 设置 distince
`Example<T>`	`setEndSql(String endSql)` 设置结尾 SQL
`Example<T>`	`setOrderByClause(String orderByClause)` 设置排序列
`Example<T>`	`setSelectColumns(String selectColumns)` 指定查询列
`Example<T>`	`setSimpleSelectColumns(String simpleSelectColumns)` 设置简单查询列，不能带别名
`Example<T>`	`setStartSql(String startSql)` 设置起始 SQL

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

- Field Detail
  - orderByClause
```
protected String orderByClause
```
    排序字段
  - distinct
```
protected boolean distinct
```
    是否使用 distinct
  - selectColumns
```
protected String selectColumns
```
    指定查询列
  - simpleSelectColumns
```
protected String simpleSelectColumns
```
    指定查询列，不带 column As Alias 别名
  - startSql
```
protected String startSql
```
    起始 SQL，添加到 SQL 前，注意防止 SQL 注入
  - endSql
```
protected String endSql
```
    结尾 SQL，添加到 SQL 最后，注意防止 SQL 注入
  - oredCriteria
```
protected List<Example.Criteria<T>> oredCriteria
```
    多组条件通过 OR 连接
  - setValues
```
protected List<Example.Criterion> setValues
```
    设置 update 时的 set 字段
- Constructor Detail
  - Example
```
public Example()
```
    默认构造方法，不允许Example查询条件为空，不能操作全库
- Method Detail
  - or
```
public void or(Example.Criteria<T> criteria)
```
    or 条件
    
    Parameters:
    
    criteria - 条件
  - or
```
public Example.Criteria<T> or()
```
    or 一组条件
    
    Returns:
    
    条件
  - orPart
```
public Example.OrCriteria<T> orPart()
```
    创建一个 or条件片段（不追加到当前Example）
    
    Returns:
    
    条件
  - createCriteria
```
public Example.Criteria<T> createCriteria()
```
    创建一组条件，第一次调用时添加到默认条件中
    
    Returns:
    
    条件
  - createCriteriaInternal
```
protected Example.Criteria<T> createCriteriaInternal()
```
  - clear
```
public void clear()
```
    清除所有设置
  - selectColumns
```
@SafeVarargs
public final Example<T> selectColumns(Fn<T,Object>... fns)
```
    指定查询列
    
    Parameters:
    
    fns - 方法引用
  - getSelectColumns
```
public String getSelectColumns()
```
    获取查询列
    
    Returns:
    
    查询列
  - getSimpleSelectColumns
```
public String getSimpleSelectColumns()
```
    获取查询列，不带 column As Alias 别名
    
    Returns:
    
    查询列
  - setSelectColumns
```
public Example<T> setSelectColumns(String selectColumns)
```
    指定查询列
    
    Parameters:
    
    selectColumns - 查询列
  - setSimpleSelectColumns
```
public Example<T> setSimpleSelectColumns(String simpleSelectColumns)
```
    设置简单查询列，不能带别名
    
    Parameters:
    
    simpleSelectColumns - 简单查询列
  - getStartSql
```
public String getStartSql()
```
    获取起始 SQL
    
    Returns:
    
    起始 SQL
  - setStartSql
```
public Example<T> setStartSql(String startSql)
```
    设置起始 SQL
    
    Parameters:
    
    startSql - 起始 SQL，添加到 SQL 前，注意防止 SQL 注入
  - getEndSql
```
public String getEndSql()
```
    获取结尾 SQL
    
    Returns:
    
    结尾 SQL
  - setEndSql
```
public Example<T> setEndSql(String endSql)
```
    设置结尾 SQL
    
    Parameters:
    
    endSql - 结尾 SQL，添加到 SQL 最后，注意防止 SQL 注入
  - orderBy
```
public Example<T> orderBy(Fn<T,Object> fn,
                          Example.Order order)
```
    通过方法引用方式设置排序字段
    
    Parameters:
    
    fn - 排序列的方法引用
    
    order - 排序方式
    
    Returns:
    
    Example
  - orderByAsc
```
@SafeVarargs
public final Example<T> orderByAsc(Fn<T,Object>... fns)
```
    通过方法引用方式设置排序字段，升序排序
    
    Parameters:
    
    fns - 排序列的方法引用
    
    Returns:
    
    Example
  - orderByDesc
```
@SafeVarargs
public final Example<T> orderByDesc(Fn<T,Object>... fns)
```
    通过方法引用方式设置排序字段，降序排序
    
    Parameters:
    
    fns - 排序列的方法引用
    
    Returns:
    
    Example
  - getOrderByClause
```
public String getOrderByClause()
```
    获取排序列
    
    Returns:
    
    排序列
  - setOrderByClause
```
public Example<T> setOrderByClause(String orderByClause)
```
    设置排序列
    
    Parameters:
    
    orderByClause - 排序列
  - getOredCriteria
```
public List<Example.Criteria<T>> getOredCriteria()
```
    获取所有条件
    
    Returns:
    
    条件
  - getSetValues
```
public List<Example.Criterion> getSetValues()
```
    获取 set 值
  - isEmpty
```
public boolean isEmpty()
```
    查询条件是否为空
    
    Returns:
  - isDistinct
```
public boolean isDistinct()
```
    是否使用 distince
    
    Returns:
    
    distince
  - setDistinct
```
public Example<T> setDistinct(boolean distinct)
```
    设置 distince
    
    Parameters:
    
    distinct - true启用，false不使用
  - set
```
public Example<T> set(String setSql)
```
    设置更新字段和值
    
    Parameters:
    
    setSql - "column = value"
  - set
```
public Example<T> set(Fn<T,Object> fn,
                      Object value)
```
    设置更新字段和值
    
    Parameters:
    
    fn - 字段
    
    value - 值

Class Example<T>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

orderByClause

distinct

selectColumns

simpleSelectColumns

startSql

endSql

oredCriteria

setValues

Constructor Detail

Example

Method Detail

or

or

orPart

createCriteria

createCriteriaInternal

clear

selectColumns

getSelectColumns

getSimpleSelectColumns

setSelectColumns

setSimpleSelectColumns

getStartSql

setStartSql

getEndSql

setEndSql

orderBy

orderByAsc

orderByDesc

getOrderByClause

setOrderByClause

getOredCriteria

getSetValues

isEmpty

isDistinct

setDistinct

set

set