SensitiveWordBs (sensitive-word 0.2.0 API)

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

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

从以下版本开始:

0.0.1

作者:

binbin.hou

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`contains(String target)` 是否包含敏感词
`SensitiveWordBs`	`enableEmailCheck(boolean enableEmailCheck)` 设置是否启动 email 检测
`SensitiveWordBs`	`enableNumCheck(boolean enableNumCheck)` 设置是否启动数字检测
`SensitiveWordBs`	`enableUrlCheck(boolean enableUrlCheck)` 设置是否启动 url 检测
`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
`String`	`replace(String target)` 替换所有内容 1.
`String`	`replace(String target, char replaceChar)` 替换所有内容
`String`	`replace(String target, ISensitiveWordReplace replace)` 替换所有内容
`SensitiveWordBs`	`wordAllow(IWordAllow wordAllow)` 设置允许的实现
`SensitiveWordBs`	`wordDeny(IWordDeny wordDeny)` 设置禁止的实现

从类继承的方法 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
  - wordDeny
```
public SensitiveWordBs wordDeny(IWordDeny wordDeny)
```
    设置禁止的实现
    
    参数:
    
    wordDeny - 禁止的实现
    
    返回:
    
    this
    
    从以下版本开始:
    
    0.0.13
  - wordAllow
```
public SensitiveWordBs wordAllow(IWordAllow wordAllow)
```
    设置允许的实现
    
    参数:
    
    wordAllow - 允许的实现
    
    返回:
    
    this
    
    从以下版本开始:
    
    0.0.13
  - enableNumCheck
```
public SensitiveWordBs enableNumCheck(boolean enableNumCheck)
```
    设置是否启动数字检测
    
    参数:
    
    enableNumCheck - 数字检测
    
    返回:
    
    this
    
    从以下版本开始:
    
    0.0.11
  - 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,
                      char replaceChar)
```
    替换所有内容
    
    参数:
    
    target - 目标字符串
    
    replaceChar - 替换为的 char
    
    返回:
    
    替换后结果
    
    从以下版本开始:
    
    0.0.2
  - replace
```
public String replace(String target,
                      ISensitiveWordReplace replace)
```
    替换所有内容
    
    参数:
    
    target - 目标字符串
    
    replace - 替换策略
    
    返回:
    
    替换后结果
    
    从以下版本开始:
    
    0.2.0
  - replace
```
public String replace(String target)
```
    替换所有内容 1. 默认使用空格替换，避免星号改变 md 的格式。
    
    参数:
    
    target - 目标字符串
    
    返回:
    
    替换后结果
    
    从以下版本开始:
    
    0.0.2

类 SensitiveWordBs

方法概要

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

方法详细资料

newInstance

init

wordDeny

wordAllow

enableNumCheck

enableEmailCheck

enableUrlCheck

ignoreCase

ignoreWidth

ignoreNumStyle

ignoreChineseStyle

ignoreEnglishStyle

ignoreRepeat

contains

findAll

findFirst

findAll

findFirst

replace

replace

replace