com.github.houbb.sensitive.word.api

接口 IWordMap

所有超级接口:

ISensitiveCheck

所有已知实现类:

SensitiveWordMap

public interface IWordMap
extends ISensitiveCheck

敏感词 map

从以下版本开始:

0.0.1

作者:

binbin.hou

方法概要

限定符和类型	方法和说明
boolean	contains(String string, IWordContext context) 是否包含敏感词
List<IWordResult>	findAll(String string, IWordContext context) 返回所有对应的敏感词
IWordResult	findFirst(String string, IWordContext context) 返回第一个对应的敏感词
void	initWordMap(Collection<String> collection) 初始化敏感词 map
String	replace(String target, ISensitiveWordReplace replace, IWordContext context) 替换所有敏感词内容 ps: 这里可以添加优化。

从接口继承的方法 com.github.houbb.sensitive.word.support.check.ISensitiveCheck

sensitiveCheck

方法详细资料

initWordMap

void initWordMap(Collection<String> collection)

初始化敏感词 map

参数:

collection - 集合信息

从以下版本开始:

0.0.1

contains

boolean contains(String string,
                 IWordContext context)

是否包含敏感词

参数:

string - 字符串

context - 上下文

返回:

是否包含

从以下版本开始:

0.0.1

另请参阅:

建议使用快速返回模式

findAll

List<IWordResult> findAll(String string,
                          IWordContext context)

返回所有对应的敏感词

参数:

string - 原始字符串

context - 上下文

返回:

结果

从以下版本开始:

0.0.1

另请参阅:

建议使用全部检测返回模式

findFirst

IWordResult findFirst(String string,
                      IWordContext context)

返回第一个对应的敏感词

参数:

string - 原始字符串

context - 上下文

返回:

结果

从以下版本开始:

0.0.1

replace

String replace(String target,
               ISensitiveWordReplace replace,
               IWordContext context)

替换所有敏感词内容 ps: 这里可以添加优化。

参数:

target - 目标字符串

replace - 替换策略

context - 上下文

返回:

替换后结果

从以下版本开始:

0.0.2