SqlScript (MyBatis Provider 2.2.0 API)

All Known Subinterfaces:

SqlScript.SqlScript2
```
public interface SqlScript
```
对 xml 形式 sql 简单封装，便于使用

Author:

liuzh

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`SqlScript.LRSupplier` 保证所有字符串前面都有换行符
`static interface`	`SqlScript.SqlScript2` 支持简单写法

Field Summary

Fields
Modifier and Type Field and Description

static String LF
换行符

Fields
Modifier and Type	Field and Description
`static String`	`LF` 换行符

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default String`	`bind(String name, String value)` 生成 bind 标签包装的 xml 结构
`static String`	`caching(org.apache.ibatis.builder.annotation.ProviderContext providerContext, SqlScript.SqlScript2 sqlScript)` 创建SQL并缓存
`static String`	`caching(org.apache.ibatis.builder.annotation.ProviderContext providerContext, SqlScript sqlScript)` 创建SQL并缓存
`default String`	`choose(SqlScript.LRSupplier content)` 生成 choose 标签包装的 xml 结构
`default String`	`foreach(String collection, String item, SqlScript.LRSupplier content)` 生成 foreach 标签包装的 xml 结构
`default String`	`foreach(String collection, String item, String separator, SqlScript.LRSupplier content)` 生成 foreach 标签包装的 xml 结构
`default String`	`foreach(String collection, String item, String separator, String open, String close, SqlScript.LRSupplier content)` 生成 foreach 标签包装的 xml 结构
`default String`	`foreach(String collection, String item, String separator, String open, String close, String index, SqlScript.LRSupplier content)` 生成 foreach 标签包装的 xml 结构
`String`	`getSql(EntityTable entity)` 生成对应的 SQL，支持动态标签
`default String`	`ifParameterNotNull(SqlScript.LRSupplier content)` 生成 <if test="_parameter != null"> 标签包装的 xml 结构，允许参数为空时使用，当参数必填时，可以使用 `parameterNotNull(String)` 方法
`default String`	`ifTest(String test, SqlScript.LRSupplier content)` 生成 if 标签包装的 xml 结构
`default String`	`otherwise(SqlScript.LRSupplier content)` 生成 otherwise 标签包装的 xml 结构
`default String`	`parameterNotNull(String message)` 增加对参数的校验，参数不能为空
`default String`	`set(SqlScript.LRSupplier content)` 生成 set 标签包装的 xml 结构
`default String`	`trim(String prefix, String suffix, String prefixOverrides, String suffixOverrides, SqlScript.LRSupplier content)` 生成 trim 标签包装的 xml 结构
`default String`	`trimPrefixOverrides(String prefix, String suffix, String prefixOverrides, SqlScript.LRSupplier content)` 生成 trim 标签包装的 xml 结构
`default String`	`trimSuffixOverrides(String prefix, String suffix, String suffixOverrides, SqlScript.LRSupplier content)` 生成 trim 标签包装的 xml 结构
`default String`	`variableIsFalse(String variable, String message)` 增加对参数的校验，参数必须为 false
`default String`	`variableIsTrue(String variable, String message)` 增加对参数的校验，参数必须为 true
`default String`	`variableNotEmpty(String variable, String message)` 增加对参数的校验，参数不能为空
`default String`	`variableNotNull(String variable, String message)` 增加对参数的校验，参数不能为 null
`default String`	`whenTest(String test, SqlScript.LRSupplier content)` 生成 when 标签包装的 xml 结构
`default String`	`where(SqlScript.LRSupplier content)` 生成 where 标签包装的 xml 结构

Field Detail
- LF
```
static final String LF
```
  换行符
  
  See Also:
  
  Constant Field Values

Method Detail

caching

static String caching(org.apache.ibatis.builder.annotation.ProviderContext providerContext,
                      SqlScript sqlScript)

创建SQL并缓存

Parameters:: providerContext - 执行方法上下文; sqlScript - xml sql 脚本实现
Returns:: 缓存key

caching

static String caching(org.apache.ibatis.builder.annotation.ProviderContext providerContext,
                      SqlScript.SqlScript2 sqlScript)

创建SQL并缓存

Parameters:: providerContext - 执行方法上下文; sqlScript - xml sql 脚本实现
Returns:: 缓存key

where
```
default String where(SqlScript.LRSupplier content)
```
生成 where 标签包装的 xml 结构

Parameters:

content - 标签中的内容

Returns:

where 标签包装的 xml 结构

getSql
```
String getSql(EntityTable entity)
```
生成对应的 SQL，支持动态标签

Parameters:

entity - 实体类信息

Returns:

xml sql 脚本

choose
```
default String choose(SqlScript.LRSupplier content)
```
生成 choose 标签包装的 xml 结构

Parameters:

content - 标签中的内容

Returns:

choose 标签包装的 xml 结构

otherwise
```
default String otherwise(SqlScript.LRSupplier content)
```
生成 otherwise 标签包装的 xml 结构

Parameters:

content - 标签中的内容

Returns:

otherwise 标签包装的 xml 结构

set
```
default String set(SqlScript.LRSupplier content)
```
生成 set 标签包装的 xml 结构

Parameters:

content - 标签中的内容

Returns:

set 标签包装的 xml 结构

ifTest
```
default String ifTest(String test,
                      SqlScript.LRSupplier content)
```
生成 if 标签包装的 xml 结构

Parameters:

test - if 的判断条件

content - 标签中的内容

Returns:

if 标签包装的 xml 结构

ifParameterNotNull
```
default String ifParameterNotNull(SqlScript.LRSupplier content)
```
生成 <if test="_parameter != null"> 标签包装的 xml 结构，允许参数为空时使用，当参数必填时，可以使用 parameterNotNull(String) 方法

Parameters:

content - 标签中的内容

Returns:

<if test="_parameter != null"> 标签包装的 xml 结构

parameterNotNull
```
default String parameterNotNull(String message)
```
增加对参数的校验，参数不能为空

Parameters:

message - 提示信息

Returns:

在代码基础上增加一段校验

variableIsTrue
```
default String variableIsTrue(String variable,
                              String message)
```
增加对参数的校验，参数必须为 true

Parameters:

variable - 参数, 值为 boolean

message - 提示信息

Returns:

在代码基础上增加一段校验

variableIsFalse
```
default String variableIsFalse(String variable,
                               String message)
```
增加对参数的校验，参数必须为 false

Parameters:

variable - 参数, 值为 boolean

message - 提示信息

Returns:

在代码基础上增加一段校验

variableNotNull
```
default String variableNotNull(String variable,
                               String message)
```
增加对参数的校验，参数不能为 null

Parameters:

variable - 参数

message - 提示信息

Returns:

在代码基础上增加一段校验

variableNotEmpty

default String variableNotEmpty(String variable,
                                String message)

增加对参数的校验，参数不能为空

Parameters:: message - 提示信息
Returns:: 在代码基础上增加一段校验

whenTest
```
default String whenTest(String test,
                        SqlScript.LRSupplier content)
```
生成 when 标签包装的 xml 结构

Parameters:

test - when 的判断条件

content - 标签中的内容

Returns:

when 标签包装的 xml 结构

trim

default String trim(String prefix,
                    String suffix,
                    String prefixOverrides,
                    String suffixOverrides,
                    SqlScript.LRSupplier content)

生成 trim 标签包装的 xml 结构

Parameters:: prefix - 前缀; suffix - 后缀; prefixOverrides - 前缀替换内容; suffixOverrides - 后缀替换内容; content - 标签中的内容
Returns:: trim 标签包装的 xml 结构

trimPrefixOverrides

default String trimPrefixOverrides(String prefix,
                                   String suffix,
                                   String prefixOverrides,
                                   SqlScript.LRSupplier content)

生成 trim 标签包装的 xml 结构

Parameters:: prefix - 前缀; suffix - 后缀; prefixOverrides - 前缀替换内容; content - 标签中的内容
Returns:: trim 标签包装的 xml 结构

trimSuffixOverrides

default String trimSuffixOverrides(String prefix,
                                   String suffix,
                                   String suffixOverrides,
                                   SqlScript.LRSupplier content)

生成 trim 标签包装的 xml 结构

Parameters:: prefix - 前缀; suffix - 后缀; suffixOverrides - 后缀替换内容; content - 标签中的内容
Returns:: trim 标签包装的 xml 结构

foreach

default String foreach(String collection,
                       String item,
                       SqlScript.LRSupplier content)

生成 foreach 标签包装的 xml 结构

Parameters:: collection - 遍历的对象; item - 对象名; content - 标签中的内容
Returns:: foreach 标签包装的 xml 结构

foreach

default String foreach(String collection,
                       String item,
                       String separator,
                       SqlScript.LRSupplier content)

生成 foreach 标签包装的 xml 结构

Parameters:: collection - 遍历的对象; item - 对象名; separator - 连接符; content - 标签中的内容
Returns:: foreach 标签包装的 xml 结构

foreach

default String foreach(String collection,
                       String item,
                       String separator,
                       String open,
                       String close,
                       SqlScript.LRSupplier content)

生成 foreach 标签包装的 xml 结构

Parameters:: collection - 遍历的对象; item - 对象名; separator - 连接符; open - 开始符号; close - 结束符号; content - 标签中的内容
Returns:: foreach 标签包装的 xml 结构

foreach

default String foreach(String collection,
                       String item,
                       String separator,
                       String open,
                       String close,
                       String index,
                       SqlScript.LRSupplier content)

生成 foreach 标签包装的 xml 结构

Parameters:: collection - 遍历的对象; item - 对象名; separator - 连接符; open - 开始符号; close - 结束符号; index - 索引名（list为索引，map为key）; content - 标签中的内容
Returns:: foreach 标签包装的 xml 结构

bind
```
default String bind(String name,
                    String value)
```
生成 bind 标签包装的 xml 结构

Parameters:

name - 变量名

value - 变量值

Returns:

bind 标签包装的 xml 结构

Interface SqlScript

Nested Class Summary

Field Summary

Method Summary

Field Detail

LF

Method Detail

caching

caching

where

getSql

choose

otherwise

set

ifTest

ifParameterNotNull

parameterNotNull

variableIsTrue

variableIsFalse

variableNotNull

variableNotEmpty

whenTest

trim

trimPrefixOverrides

trimSuffixOverrides

foreach

foreach

foreach

foreach

bind