CensoringWordGenerator (Atlassian Confluence 8.8.0 API)

java.lang.Object
- com.atlassian.confluence.internal.security.captcha.CensoringWordGenerator

All Implemented Interfaces:

com.octo.captcha.component.word.wordgenerator.WordGenerator
```
public final class CensoringWordGenerator
extends Object
implements com.octo.captcha.component.word.wordgenerator.WordGenerator
```
A word generator that wraps around another word generator, and censors the words that the wrapped generator produces.

Since:

6.0.6

Constructor Summary

Constructors
Constructor	Description
`CensoringWordGenerator(com.octo.captcha.component.word.wordgenerator.WordGenerator censoredWordGenerator)`	Constructs a censoring word generator that censors the given word generator.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

String getWord(Integer length)

String getWord(Integer length, Locale locale)
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CensoringWordGenerator
```
public CensoringWordGenerator(com.octo.captcha.component.word.wordgenerator.WordGenerator censoredWordGenerator)
```
    Constructs a censoring word generator that censors the given word generator.
    
    Parameters:
    
    censoredWordGenerator - the word generator that will be censored. Must not be null.
- Method Detail
  - getWord
```
public String getWord(Integer length)
```
    Specified by:
    
    getWord in interface com.octo.captcha.component.word.wordgenerator.WordGenerator
  - getWord
```
public String getWord(Integer length,
                      Locale locale)
```
    Specified by:
    
    getWord in interface com.octo.captcha.component.word.wordgenerator.WordGenerator