SensitiveWordBs (sensitive-word 0.25.0 API)

java.lang.Object
- com.github.houbb.sensitive.word.bs.SensitiveWordBs

所有已实现的接口:

ISensitiveWordDestroy
```
public class SensitiveWordBs
extends Object
implements ISensitiveWordDestroy
```
敏感词引导类

从以下版本开始:

0.0.1

作者:

binbin.hou

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addWord(Collection<String> collection)` 新增敏感词
`void`	`addWord(String word, String... others)` 新增敏感词
`void`	`addWordAllow(Collection<String> collection)` 新增敏感词白名单
`void`	`addWordAllow(String word, String... others)` 新增敏感词白名单
`SensitiveWordBs`	`charIgnore(ISensitiveWordCharIgnore charIgnore)`
`boolean`	`contains(String target)` 是否包含敏感词
`void`	`destroy()` 资源的销毁
`SensitiveWordBs`	`enableEmailCheck(boolean enableEmailCheck)` 设置是否启动 email 检测
`SensitiveWordBs`	`enableIpv4Check(boolean enableIpv4Check)` 是否启用 ipv4 校验
`SensitiveWordBs`	`enableNumCheck(boolean enableNumCheck)` 设置是否启动数字检测
`SensitiveWordBs`	`enableUrlCheck(boolean enableUrlCheck)` 设置是否启动 url 检测
`SensitiveWordBs`	`enableWordCheck(boolean enableWordCheck)` 设置是否启动数字检测
`List<String>`	`findAll(String target)` 返回所有的敏感词 1.
`<R> List<R>`	`findAll(String target, IWordResultHandler<R> handler)` 返回所有的敏感词 1.
`String`	`findFirst(String target)` 返回第一个敏感词（1）如果不存在，则返回 `null`
`<R> R`	`findFirst(String target, IWordResultHandler<R> handler)` 返回第一个敏感词（1）如果不存在，则返回 `null`
`SensitiveWordBs`	`ignoreCase(boolean ignoreCase)` 是否忽略大小写
`SensitiveWordBs`	`ignoreChineseStyle(boolean ignoreChineseStyle)` 是否忽略中文样式
`SensitiveWordBs`	`ignoreEnglishStyle(boolean ignoreEnglishStyle)` 是否忽略英文样式
`SensitiveWordBs`	`ignoreNumStyle(boolean ignoreNumStyle)` 是否忽略数字格式
`SensitiveWordBs`	`ignoreRepeat(boolean ignoreRepeat)` 是否忽略重复
`SensitiveWordBs`	`ignoreWidth(boolean ignoreWidth)` 是否忽略半角全角
`SensitiveWordBs`	`init()` 初始化 1.
`static SensitiveWordBs`	`newInstance()` 新建验证实例 double-lock
`SensitiveWordBs`	`numCheckLen(int numCheckLen)` 检测敏感词对应的长度限制，便于用户灵活定义
`void`	`removeWord(Collection<String> collection)` 删除单词
`void`	`removeWord(String word, String... others)` 删除敏感词
`void`	`removeWordAllow(Collection<String> collection)` 删除敏感词白名单
`void`	`removeWordAllow(String word, String... others)` 删除敏感词白名单
`String`	`replace(String target)` 替换所有内容
`SensitiveWordBs`	`sensitiveWord(ISensitiveWord sensitiveWord)`
`Set<String>`	`tags(String word)` 获取敏感词的标签
`SensitiveWordBs`	`wordAllow(IWordAllow wordAllow)` 设置允许的实现
`SensitiveWordBs`	`wordAllowDenyCombine(IWordAllowDenyCombine wordAllowDenyCombine)`
`SensitiveWordBs`	`wordCheckCombine(IWordCheckCombine wordCheckCombine)`
`SensitiveWordBs`	`wordCheckEmail(IWordCheck wordCheckEmail)`
`SensitiveWordBs`	`wordCheckIpv4(IWordCheck wordCheckIpv4)`
`SensitiveWordBs`	`wordCheckNum(IWordCheck wordCheckNum)`
`SensitiveWordBs`	`wordCheckUrl(IWordCheck wordCheckUrl)`
`SensitiveWordBs`	`wordCheckWord(IWordCheck wordCheckWord)`
`SensitiveWordBs`	`wordData(IWordData wordData)` 允许指定策略数据
`SensitiveWordBs`	`wordDataAllow(IWordData wordDataAllow)`
`SensitiveWordBs`	`wordDeny(IWordDeny wordDeny)` 设置禁止的实现
`SensitiveWordBs`	`wordFormatCombine(IWordFormatCombine wordFormatCombine)`
`SensitiveWordBs`	`wordReplace(IWordReplace wordReplace)` 设置替换策略
`SensitiveWordBs`	`wordResultCondition(IWordResultCondition wordResultCondition)`
`SensitiveWordBs`	`wordTag(IWordTag wordTag)`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - newInstance
```
public static SensitiveWordBs newInstance()
```
    新建验证实例
    double-lock
    
    返回:
    
    this
    
    从以下版本开始:
    
    0.0.1
  - init
```
public SensitiveWordBs init()
```
    初始化 1. 根据配置，初始化对应的 map。比较消耗性能。
    
    返回:
    
    this
    
    从以下版本开始:
    
    0.0.13
  - wordResultCondition
```
public SensitiveWordBs wordResultCondition(IWordResultCondition wordResultCondition)
```
  - charIgnore
```
public SensitiveWordBs charIgnore(ISensitiveWordCharIgnore charIgnore)
```
  - wordTag
```
public SensitiveWordBs wordTag(IWordTag wordTag)
```
  - wordCheckCombine
```
public SensitiveWordBs wordCheckCombine(IWordCheckCombine wordCheckCombine)
```
  - wordFormatCombine
```
public SensitiveWordBs wordFormatCombine(IWordFormatCombine wordFormatCombine)
```
  - wordAllowDenyCombine
```
public SensitiveWordBs wordAllowDenyCombine(IWordAllowDenyCombine wordAllowDenyCombine)
```
  - wordData
```
public SensitiveWordBs wordData(IWordData wordData)
```
    允许指定策略数据
    
    参数:
    
    wordData - 单词数据
    
    返回:
    
    结果
    
    从以下版本开始:
    
    0.7.0
  - wordDataAllow
```
public SensitiveWordBs wordDataAllow(IWordData wordDataAllow)
```
  - sensitiveWord
```
public SensitiveWordBs sensitiveWord(ISensitiveWord sensitiveWord)
```
  - wordReplace
```
public SensitiveWordBs wordReplace(IWordReplace wordReplace)
```
    设置替换策略
    
    参数:
    
    wordReplace - 替换
    
    返回:
    
    结果
  - wordDeny
```
public SensitiveWordBs wordDeny(IWordDeny wordDeny)
```
    设置禁止的实现
    
    参数:
    
    wordDeny - 禁止的实现
    
    返回:
    
    this
    
    从以下版本开始:
    
    0.0.13
  - wordAllow
```
public SensitiveWordBs wordAllow(IWordAllow wordAllow)
```
    设置允许的实现
    
    参数:
    
    wordAllow - 允许的实现
    
    返回:
    
    this
    
    从以下版本开始:
    
    0.0.13
  - wordCheckWord
```
public SensitiveWordBs wordCheckWord(IWordCheck wordCheckWord)
```
  - wordCheckNum
```
public SensitiveWordBs wordCheckNum(IWordCheck wordCheckNum)
```
  - wordCheckEmail
```
public SensitiveWordBs wordCheckEmail(IWordCheck wordCheckEmail)
```
  - wordCheckUrl
```
public SensitiveWordBs wordCheckUrl(IWordCheck wordCheckUrl)
```
  - wordCheckIpv4
```
public SensitiveWordBs wordCheckIpv4(IWordCheck wordCheckIpv4)
```
  - enableIpv4Check
```
public SensitiveWordBs enableIpv4Check(boolean enableIpv4Check)
```
    是否启用 ipv4 校验
    
    参数:
    
    enableIpv4Check - 是否启用
    
    返回:
    
    this
    
    从以下版本开始:
    
    0.17.0
  - enableWordCheck
```
public SensitiveWordBs enableWordCheck(boolean enableWordCheck)
```
    设置是否启动数字检测
    
    参数:
    
    enableWordCheck - 数字检测
    
    返回:
    
    this
    
    从以下版本开始:
    
    0.0.11
  - enableNumCheck
```
public SensitiveWordBs enableNumCheck(boolean enableNumCheck)
```
    设置是否启动数字检测
    
    参数:
    
    enableNumCheck - 数字检测
    
    返回:
    
    this
    
    从以下版本开始:
    
    0.0.11
  - numCheckLen
```
public SensitiveWordBs numCheckLen(int numCheckLen)
```
    检测敏感词对应的长度限制，便于用户灵活定义
    
    参数:
    
    numCheckLen - 长度
    
    返回:
    
    this
    
    从以下版本开始:
    
    0.2.1
  - enableEmailCheck
```
public SensitiveWordBs enableEmailCheck(boolean enableEmailCheck)
```
    设置是否启动 email 检测
    
    参数:
    
    enableEmailCheck - email 检测
    
    返回:
    
    this
    
    从以下版本开始:
    
    0.0.11
  - enableUrlCheck
```
public SensitiveWordBs enableUrlCheck(boolean enableUrlCheck)
```
    设置是否启动 url 检测
    
    参数:
    
    enableUrlCheck - url 检测
    
    返回:
    
    this
    
    从以下版本开始:
    
    0.0.12
  - ignoreCase
```
public SensitiveWordBs ignoreCase(boolean ignoreCase)
```
    是否忽略大小写
    
    参数:
    
    ignoreCase - 大小写
    
    返回:
    
    this
    
    从以下版本开始:
    
    0.0.14
  - ignoreWidth
```
public SensitiveWordBs ignoreWidth(boolean ignoreWidth)
```
    是否忽略半角全角
    
    参数:
    
    ignoreWidth - 半角全角
    
    返回:
    
    this
    
    从以下版本开始:
    
    0.0.14
  - ignoreNumStyle
```
public SensitiveWordBs ignoreNumStyle(boolean ignoreNumStyle)
```
    是否忽略数字格式
    
    参数:
    
    ignoreNumStyle - 数字格式
    
    返回:
    
    this
    
    从以下版本开始:
    
    0.0.14
  - ignoreChineseStyle
```
public SensitiveWordBs ignoreChineseStyle(boolean ignoreChineseStyle)
```
    是否忽略中文样式
    
    参数:
    
    ignoreChineseStyle - 中文样式
    
    返回:
    
    this
    
    从以下版本开始:
    
    0.0.14
  - ignoreEnglishStyle
```
public SensitiveWordBs ignoreEnglishStyle(boolean ignoreEnglishStyle)
```
    是否忽略英文样式
    
    参数:
    
    ignoreEnglishStyle - 英文样式
    
    返回:
    
    this
    
    从以下版本开始:
    
    0.0.14
  - ignoreRepeat
```
public SensitiveWordBs ignoreRepeat(boolean ignoreRepeat)
```
    是否忽略重复
    
    参数:
    
    ignoreRepeat - 忽略重复
    
    返回:
    
    this
    
    从以下版本开始:
    
    0.0.14
  - contains
```
public boolean contains(String target)
```
    是否包含敏感词
    
    参数:
    
    target - 目标字符串
    
    返回:
    
    是否
    
    从以下版本开始:
    
    0.0.1
  - findAll
```
public List<String> findAll(String target)
```
    返回所有的敏感词 1. 这里是默认去重的，且是有序的。 2. 如果不存在，返回空列表
    
    参数:
    
    target - 目标字符串
    
    返回:
    
    敏感词列表
    
    从以下版本开始:
    
    0.0.1
  - findFirst
```
public String findFirst(String target)
```
    返回第一个敏感词（1）如果不存在，则返回 null
    
    参数:
    
    target - 目标字符串
    
    返回:
    
    敏感词
    
    从以下版本开始:
    
    0.0.1
  - findAll
```
public <R> List<R> findAll(String target,
                           IWordResultHandler<R> handler)
```
    返回所有的敏感词 1. 这里是默认去重的，且是有序的。 2. 如果不存在，返回空列表
    
    类型参数:
    
    R - 泛型
    
    参数:
    
    target - 目标字符串
    
    handler - 处理类
    
    返回:
    
    敏感词列表
    
    从以下版本开始:
    
    0.0.1
  - findFirst
```
public <R> R findFirst(String target,
                       IWordResultHandler<R> handler)
```
    返回第一个敏感词（1）如果不存在，则返回 null
    
    类型参数:
    
    R - 泛型
    
    参数:
    
    target - 目标字符串
    
    handler - 处理类
    
    返回:
    
    敏感词
    
    从以下版本开始:
    
    0.0.1
  - replace
```
public String replace(String target)
```
    替换所有内容
    
    参数:
    
    target - 目标字符串
    
    返回:
    
    替换后结果
    
    从以下版本开始:
    
    0.2.0
  - tags
```
public Set<String> tags(String word)
```
    获取敏感词的标签
    
    参数:
    
    word - 敏感词
    
    返回:
    
    结果
    
    从以下版本开始:
    
    0.10.0
  - destroy
```
public void destroy()
```
    从接口复制的说明: ISensitiveWordDestroy
    
    资源的销毁
    
    指定者:
    
    destroy 在接口中 ISensitiveWordDestroy
  - removeWord
```
public void removeWord(String word,
                       String... others)
```
    删除敏感词
    
    参数:
    
    word - 单词
    
    others - 其他
    
    从以下版本开始:
    
    0.19.0
  - removeWord
```
public void removeWord(Collection<String> collection)
```
    删除单词
    
    参数:
    
    collection - 集合
    
    从以下版本开始:
    
    0.19.0
  - addWord
```
public void addWord(Collection<String> collection)
```
    新增敏感词
    
    参数:
    
    collection - 敏感词集合
    
    从以下版本开始:
    
    0.19.0
  - addWord
```
public void addWord(String word,
                    String... others)
```
    新增敏感词
    
    参数:
    
    word - 敏感词
    
    others - 其他
    
    从以下版本开始:
    
    0.19.0
  - removeWordAllow
```
public void removeWordAllow(String word,
                            String... others)
```
    删除敏感词白名单
    
    参数:
    
    word - 单词
    
    others - 其他
    
    从以下版本开始:
    
    0.21.0
  - removeWordAllow
```
public void removeWordAllow(Collection<String> collection)
```
    删除敏感词白名单
    
    参数:
    
    collection - 集合
    
    从以下版本开始:
    
    0.21.0
  - addWordAllow
```
public void addWordAllow(Collection<String> collection)
```
    新增敏感词白名单
    
    参数:
    
    collection - 敏感词白名单集合
    
    从以下版本开始:
    
    0.21.0
  - addWordAllow
```
public void addWordAllow(String word,
                         String... others)
```
    新增敏感词白名单
    
    参数:
    
    word - 敏感词白名单
    
    others - 其他
    
    从以下版本开始:
    
    0.21.0

类 SensitiveWordBs

方法概要

从类继承的方法 java.lang.Object

方法详细资料

newInstance

init

wordResultCondition

charIgnore

wordTag

wordCheckCombine

wordFormatCombine

wordAllowDenyCombine

wordData

wordDataAllow

sensitiveWord

wordReplace

wordDeny

wordAllow

wordCheckWord

wordCheckNum

wordCheckEmail

wordCheckUrl

wordCheckIpv4

enableIpv4Check

enableWordCheck

enableNumCheck

numCheckLen

enableEmailCheck

enableUrlCheck

ignoreCase

ignoreWidth

ignoreNumStyle

ignoreChineseStyle

ignoreEnglishStyle

ignoreRepeat

contains

findAll

findFirst

findAll

findFirst

replace

tags

destroy

removeWord

removeWord

addWord

addWord

removeWordAllow

removeWordAllow

addWordAllow

addWordAllow