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

使用IWordContext的程序包

程序包	说明
com.github.houbb.sensitive.word.api	api 定义
com.github.houbb.sensitive.word.api.combine
com.github.houbb.sensitive.word.api.context
com.github.houbb.sensitive.word.bs
com.github.houbb.sensitive.word.core
com.github.houbb.sensitive.word.support.combine.allowdeny
com.github.houbb.sensitive.word.support.combine.check
com.github.houbb.sensitive.word.support.combine.format
com.github.houbb.sensitive.word.support.format
com.github.houbb.sensitive.word.support.replace
com.github.houbb.sensitive.word.support.result
com.github.houbb.sensitive.word.support.resultcondition
com.github.houbb.sensitive.word.utils

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

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

限定符和类型	方法和说明
IWordContext	IWordContext.enableEmailCheck(boolean enableEmailCheck) 设置敏感邮箱检测
IWordContext	IWordContext.enableIpv4Check(boolean enableIpv4Check) 是否启用 ipv4 校验
IWordContext	IWordContext.enableNumCheck(boolean enableNumCheck) 设置敏感数字检测
IWordContext	IWordContext.enableUrlCheck(boolean enableUrlCheck) 设置敏感邮箱检测
IWordContext	IWordContext.enableWordCheck(boolean enableWordCheck) 设置是否启用单词
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.sensitiveCheck(IWordCheck sensitiveCheck) 设置检测策略
IWordContext	IWordContext.sensitiveCheckNumLen(int sensitiveCheckNumLen) 设置敏感数字检测长度
IWordContext	IWordContext.wordData(IWordData wordMap) 设置 wordMap 策略
IWordContext	IWordContext.wordDataAllow(IWordData wordDataAllow) 设置 wordDataAllow 策略
IWordContext	IWordContext.wordFormat(IWordFormat wordFormat) 设置统一的字符处理
IWordContext	IWordContext.wordReplace(IWordReplace wordReplace) 设置敏感词替换策略

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

限定符和类型	方法和说明
boolean	ISensitiveWord.contains(String string, IWordContext context) 包含
List<IWordResult>	ISensitiveWord.findAll(String string, IWordContext context) 返回所有对应的敏感词
IWordResult	ISensitiveWord.findFirst(String string, IWordContext context) 返回第一个对应的敏感词
char	IWordFormat.format(char original, IWordContext context) 针对 char 格式化
R	IWordResultHandler.handle(IWordResult wordResult, IWordContext wordContext, String originalText) 对于结果的处理
boolean	IWordResultCondition.match(IWordResult wordResult, String text, WordValidModeEnum modeEnum, IWordContext context) 是否匹配
void	IWordReplace.replace(StringBuilder stringBuilder, char[] rawChars, IWordResult wordResult, IWordContext wordContext) 替换 説明：废弃以前的字符串返回，减少对象创建，提升性能。
String	ISensitiveWord.replace(String target, IWordContext context) 替换所有敏感词内容 ps: 这里可以添加优化。

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

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

限定符和类型	方法和说明
Collection<String>	IWordAllowDenyCombine.getActualDenyList(List<String> allowList, List<String> denyList, IWordContext context) 获取最终的拒绝单词列表
IWordCheck	IWordCheckCombine.initWordCheck(IWordContext context) 初始化敏感检测策略
IWordFormat	IWordFormatCombine.initWordFormat(IWordContext context) 初始化 charFormat

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

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

限定符和类型	方法和说明
IWordContext	InnerSensitiveWordContext.wordContext()

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

限定符和类型	方法和说明
InnerSensitiveWordContext	InnerSensitiveWordContext.wordContext(IWordContext context)

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

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

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

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

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

限定符和类型	方法和说明
boolean	AbstractSensitiveWord.contains(String string, IWordContext context)
protected List<IWordResult>	SensitiveWord.doFindAll(String string, IWordContext context)
protected abstract List<IWordResult>	AbstractSensitiveWord.doFindAll(String string, IWordContext context) 执行全部替换
protected IWordResult	SensitiveWord.doFindFirst(String string, IWordContext context)
protected abstract IWordResult	AbstractSensitiveWord.doFindFirst(String string, IWordContext context)
protected String	AbstractSensitiveWord.doReplace(String target, List<IWordResult> allList, IWordContext context) 替换
List<IWordResult>	AbstractSensitiveWord.findAll(String string, IWordContext context)
IWordResult	AbstractSensitiveWord.findFirst(String string, IWordContext context)
String	AbstractSensitiveWord.replace(String target, IWordContext context)

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

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

限定符和类型	方法和说明
protected Collection<String>	WordAllowDenyCombine.doGetActualDenyList(List<String> allowList, List<String> denyList, IWordContext context)
protected abstract Collection<String>	AbstractWordAllowDenyCombine.doGetActualDenyList(List<String> allowList, List<String> denyList, IWordContext context)
Collection<String>	AbstractWordAllowDenyCombine.getActualDenyList(List<String> allowList, List<String> denyList, IWordContext context)

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

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

限定符和类型	方法和说明
protected List<IWordCheck>	WordCheckCombine.getWordCheckList(IWordContext context)
protected abstract List<IWordCheck>	AbstractWordCheckCombine.getWordCheckList(IWordContext context)
IWordCheck	AbstractWordCheckCombine.initWordCheck(IWordContext context)

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

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

限定符和类型	方法和说明
protected List<IWordFormat>	WordFormatCombine.getWordFormatList(IWordContext context)
protected abstract List<IWordFormat>	AbstractWordFormatCombine.getWordFormatList(IWordContext context)
IWordFormat	AbstractWordFormatCombine.initWordFormat(IWordContext context)

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

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

限定符和类型	方法和说明
char	WordFormatNone.format(char original, IWordContext context)
char	WordFormatInit.format(char original, IWordContext context)
char	WordFormatIgnoreWidth.format(char original, IWordContext context)
char	WordFormatIgnoreNumStyle.format(char original, IWordContext context)
char	WordFormatIgnoreEnglishStyle.format(char original, IWordContext context)
char	WordFormatIgnoreChineseStyle.format(char original, IWordContext context)
char	WordFormatIgnoreCase.format(char original, IWordContext context)

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

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

限定符和类型	方法和说明
void	WordReplaceChar.replace(StringBuilder stringBuilder, char[] rawChars, IWordResult wordResult, IWordContext wordContext)

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

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

限定符和类型	方法和说明
protected WordTagsDto	WordResultHandlerWordTags.doHandle(IWordResult wordResult, IWordContext wordContext, String originalText)
protected String	WordResultHandlerWord.doHandle(IWordResult wordResult, IWordContext wordContext, String originalText)
protected IWordResult	WordResultHandlerRaw.doHandle(IWordResult wordResult, IWordContext wordContext, String originalText)
protected abstract R	AbstractWordResultHandler.doHandle(IWordResult wordResult, IWordContext wordContext, String originalText)
R	AbstractWordResultHandler.handle(IWordResult wordResult, IWordContext wordContext, String originalText)

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

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

限定符和类型	方法和说明
protected boolean	WordResultConditionWordTagsMatch.doMatch(IWordResult wordResult, String text, WordValidModeEnum modeEnum, IWordContext context)
protected boolean	WordResultConditionInit.doMatch(IWordResult wordResult, String text, WordValidModeEnum modeEnum, IWordContext context)
protected boolean	WordResultConditionEnglishWordNumMatch.doMatch(IWordResult wordResult, String text, WordValidModeEnum modeEnum, IWordContext context)
protected boolean	WordResultConditionEnglishWordMatch.doMatch(IWordResult wordResult, String text, WordValidModeEnum modeEnum, IWordContext context)
protected boolean	WordResultConditionAlwaysTrue.doMatch(IWordResult wordResult, String text, WordValidModeEnum modeEnum, IWordContext context)
protected abstract boolean	AbstractWordResultCondition.doMatch(IWordResult wordResult, String text, WordValidModeEnum modeEnum, IWordContext context)
boolean	AbstractWordResultCondition.match(IWordResult wordResult, String text, WordValidModeEnum modeEnum, IWordContext context)

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

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

限定符和类型	方法和说明
static String	InnerWordFormatUtils.format(String original, IWordContext context) 格式化
static Map<Character,Character>	InnerWordFormatUtils.formatCharsMapping(String original, IWordContext context) 字符串统一的格式化处理
static List<String>	InnerWordFormatUtils.formatWordList(Collection<String> list, IWordContext context) 格式化列表
static Set<String>	InnerWordTagUtils.tags(String word, IWordContext wordContext) 获取敏感词的标签