接口的使用
com.github.houbb.sensitive.word.api.IWordContext

使用IWordContext的程序包

程序包	说明
com.github.houbb.sensitive.word.api	api 定义
com.github.houbb.sensitive.word.bs	引导类定义
com.github.houbb.sensitive.word.support.check
com.github.houbb.sensitive.word.support.check.impl
com.github.houbb.sensitive.word.support.format
com.github.houbb.sensitive.word.support.map
com.github.houbb.sensitive.word.utils

com.github.houbb.sensitive.word.api中IWordContext的使用

返回IWordContext的com.github.houbb.sensitive.word.api中的方法

限定符和类型	方法和说明
IWordContext	IWordContext.ignoreCase(boolean ignoreCase) 设置是否忽略大小写
IWordContext	IWordContext.ignoreChineseStyle(boolean ignoreChineseStyle) 设置是否忽略中文繁简体格式
IWordContext	IWordContext.ignoreEnglishStyle(boolean ignoreEnglishStyle) 设置忽略英文的写法
IWordContext	IWordContext.ignoreNumStyle(boolean ignoreNumStyle) 设置是否忽略半角圆角
IWordContext	IWordContext.ignoreRepeat(boolean ignoreRepeat) 设置忽略重复词
IWordContext	IWordContext.ignoreWidth(boolean ignoreWidth) 设置是否忽略半角圆角
IWordContext	IWordContext.sensitiveCheckEmail(boolean sensitiveCheckEmail) 设置敏感邮箱检测
IWordContext	IWordContext.sensitiveCheckNum(boolean sensitiveCheckNum) 设置敏感数字检测
IWordContext	IWordContext.sensitiveCheckUrl(boolean sensitiveCheckUrl) 设置敏感邮箱检测
IWordContext	IWordContext.sensitiveWordMap(Map map) 敏感词信息

参数类型为IWordContext的com.github.houbb.sensitive.word.api中的方法

限定符和类型	方法和说明
boolean	IWordMap.contains(String string, IWordContext context) 是否包含敏感词
List<IWordResult>	IWordMap.findAll(String string, IWordContext context) 返回所有对应的敏感词
IWordResult	IWordMap.findFirst(String string, IWordContext context) 返回第一个对应的敏感词
char	ICharFormat.format(char original, IWordContext context) 针对 char 格式化
String	IWordMap.replace(String target, ISensitiveWordReplace replace, IWordContext context) 替换所有敏感词内容 ps: 这里可以添加优化。

com.github.houbb.sensitive.word.bs中IWordContext的使用

实现IWordContext的com.github.houbb.sensitive.word.bs中的类

限定符和类型	类和说明
class	SensitiveWordContext 上下文

com.github.houbb.sensitive.word.support.check中IWordContext的使用

参数类型为IWordContext的com.github.houbb.sensitive.word.support.check中的方法

限定符和类型	方法和说明
SensitiveCheckResult	ISensitiveCheck.sensitiveCheck(String txt, int beginIndex, ValidModeEnum validModeEnum, IWordContext context) 检查敏感词数量 （1）如果未命中敏感词，直接返回 0 （2）命中敏感词，则返回敏感词的长度。

com.github.houbb.sensitive.word.support.check.impl中IWordContext的使用

参数类型为IWordContext的com.github.houbb.sensitive.word.support.check.impl中的方法

限定符和类型	方法和说明
SensitiveCheckResult	SensitiveCheckWord.sensitiveCheck(String txt, int beginIndex, ValidModeEnum validModeEnum, IWordContext context)
SensitiveCheckResult	SensitiveCheckUrl.sensitiveCheck(String txt, int beginIndex, ValidModeEnum validModeEnum, IWordContext context)
SensitiveCheckResult	SensitiveCheckNum.sensitiveCheck(String txt, int beginIndex, ValidModeEnum validModeEnum, IWordContext context)
SensitiveCheckResult	SensitiveCheckEmail.sensitiveCheck(String txt, int beginIndex, ValidModeEnum validModeEnum, IWordContext context)
SensitiveCheckResult	SensitiveCheckChain.sensitiveCheck(String txt, int beginIndex, ValidModeEnum validModeEnum, IWordContext context)

com.github.houbb.sensitive.word.support.format中IWordContext的使用

参数类型为IWordContext的com.github.houbb.sensitive.word.support.format中的方法

限定符和类型	方法和说明
char	IgnoreWidthCharFormat.format(char original, IWordContext context)
char	IgnoreNumStyleCharFormat.format(char original, IWordContext context)
char	IgnoreEnglishStyleFormat.format(char original, IWordContext context)
char	IgnoreChineseStyleFormat.format(char original, IWordContext context)
char	IgnoreCaseCharFormat.format(char original, IWordContext context)
char	CharFormatChain.format(char original, IWordContext context)

com.github.houbb.sensitive.word.support.map中IWordContext的使用

参数类型为IWordContext的com.github.houbb.sensitive.word.support.map中的方法

限定符和类型	方法和说明
boolean	SensitiveWordMap.contains(String string, IWordContext context) 是否包含 （1）直接遍历所有 （2）如果遇到，则直接返回 true
List<IWordResult>	SensitiveWordMap.findAll(String string, IWordContext context) 返回所有对应的敏感词 （1）结果是有序的 （2）为了保留所有的下标，结果从 v0.1.0 之后不再去重。
IWordResult	SensitiveWordMap.findFirst(String string, IWordContext context)
String	SensitiveWordMap.replace(String target, ISensitiveWordReplace replace, IWordContext context)
SensitiveCheckResult	SensitiveWordMap.sensitiveCheck(String txt, int beginIndex, ValidModeEnum validModeEnum, IWordContext context)

com.github.houbb.sensitive.word.utils中IWordContext的使用

参数类型为IWordContext的com.github.houbb.sensitive.word.utils中的方法

限定符和类型	方法和说明
static String	InnerFormatUtils.format(String original, IWordContext context) 格式化