MaskBuilder (infxnity 0.0.1-SNAPSHOT API)

java.lang.Object
- com.ben12.infxnity.control.text.MaskBuilder

All Implemented Interfaces:

Builder<MaskTextFilter.MaskCharacter[]>
```
public class MaskBuilder
extends Object
implements Builder<MaskTextFilter.MaskCharacter[]>
```
Mask builder use to create a mask for MaskTextFilter.

Author:

Benoît Moreau (ben.12)

See Also:

MaskTextFilter

Constructor Summary

Constructors
Constructor and Description

MaskBuilder()

Constructors
Constructor and Description
`MaskBuilder()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MaskBuilder`	`append(int repeat, MaskTextFilter.MaskCharacter maskCharacter)` Appends some `MaskTextFilter.MaskCharacter`.
`MaskBuilder`	`append(int repeat, Predicate<Character> allowed, char defaultValue)` Appends some characters where allowing only character defined by the `allowed` predicate.
`MaskBuilder`	`append(int repeat, Predicate<Character> allowed, UnaryOperator<Character> transformation, char defaultValue)` Appends some characters where allowing only character defined by the `allowed` predicate.
`MaskBuilder`	`append(MaskTextFilter.MaskCharacter maskCharacter)` Appends a `MaskTextFilter.MaskCharacter`.
`MaskBuilder`	`appendAny()` Appends a character where any character are allowed.
`MaskBuilder`	`appendAny(char defaultValue)` Appends a character where any character are allowed.
`MaskBuilder`	`appendAny(int repeat)` Appends some characters where any character are allowed.
`MaskBuilder`	`appendAny(int repeat, char defaultValue)` Appends some characters where any character are allowed.
`MaskBuilder`	`appendDigit()` Appends a character where only digit are allowed.
`MaskBuilder`	`appendDigit(char defaultValue)` Appends a character where only digit are allowed.
`MaskBuilder`	`appendDigit(int repeat)` Appends some characters where only digit are allowed.
`MaskBuilder`	`appendDigit(int repeat, char defaultValue)` Appends some characters where only digit are allowed.
`MaskBuilder`	`appendHexa()` Appends a character where only hexadecimal are allowed.
`MaskBuilder`	`appendHexa(char defaultValue)` Appends a character where only hexadecimal are allowed.
`MaskBuilder`	`appendHexa(int repeat)` Appends some characters where only hexadecimal are allowed.
`MaskBuilder`	`appendHexa(int repeat, char defaultValue)` Appends some characters where only hexadecimal are allowed.
`MaskBuilder`	`appendLetter()` Appends a character where only letter are allowed.
`MaskBuilder`	`appendLetter(char defaultValue)` Appends a character where only letter are allowed.
`MaskBuilder`	`appendLetter(int repeat)` Appends some characters where only letter are allowed.
`MaskBuilder`	`appendLetter(int repeat, char defaultValue)` Appends some characters where only letter are allowed.
`MaskBuilder`	`appendLetterOrDigit()` Appends a character where only letter or digit are allowed.
`MaskBuilder`	`appendLetterOrDigit(char defaultValue)` Appends a character where only letter or digit are allowed.
`MaskBuilder`	`appendLetterOrDigit(int repeat)` Appends some characters where only letter or digit are allowed.
`MaskBuilder`	`appendLetterOrDigit(int repeat, char defaultValue)` Appends some characters where only letter or digit are allowed.
`MaskBuilder`	`appendLiteral(String value)` Appends an unmodifiable text.
`MaskBuilder`	`appendLowerCase()` Appends a character where only lower case letter are allowed.
`MaskBuilder`	`appendLowerCase(char defaultValue)` Appends a character where only lower case letter are allowed.
`MaskBuilder`	`appendLowerCase(int repeat)` Appends some characters where only lower case letter are allowed.
`MaskBuilder`	`appendLowerCase(int repeat, char defaultValue)` Appends some characters where only lower case letter are allowed.
`MaskBuilder`	`appendUpperCase()` Appends a character where only upper case letter are allowed.
`MaskBuilder`	`appendUpperCase(char defaultValue)` Appends a character where only upper case letter are allowed.
`MaskBuilder`	`appendUpperCase(int repeat)` Appends some characters where only upper case letter are allowed.
`MaskBuilder`	`appendUpperCase(int repeat, char defaultValue)` Appends some characters where only upper case letter are allowed.
`MaskTextFilter.MaskCharacter[]`	`build()`
`static MaskBuilder`	`newBuilder()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MaskBuilder
```
public MaskBuilder()
```
- Method Detail
  - newBuilder
```
public static MaskBuilder newBuilder()
```
  - appendLiteral
```
public MaskBuilder appendLiteral(String value)
```
    Appends an unmodifiable text.
    
    Parameters:
    
    value - the literal string to append
    
    Returns:
    
    this MaskBuilder
  - appendDigit
```
public MaskBuilder appendDigit()
```
    Appends a character where only digit are allowed. Default value is '0'.
    
    Returns:
    
    this MaskBuilder
  - appendDigit
```
public MaskBuilder appendDigit(char defaultValue)
```
    Appends a character where only digit are allowed.
    
    Parameters:
    
    defaultValue - the default value
    
    Returns:
    
    this MaskBuilder
  - appendDigit
```
public MaskBuilder appendDigit(int repeat)
```
    Appends some characters where only digit are allowed. Default value is '0'.
    
    Parameters:
    
    repeat - number of character to append
    
    Returns:
    
    this MaskBuilder
  - appendDigit
```
public MaskBuilder appendDigit(int repeat,
                               char defaultValue)
```
    Appends some characters where only digit are allowed.
    
    Parameters:
    
    repeat - number of character to append
    
    defaultValue - the default value for each character
    
    Returns:
    
    this MaskBuilder
  - appendUpperCase
```
public MaskBuilder appendUpperCase()
```
    Appends a character where only upper case letter are allowed. Typing lower case character will set an upper case character. Default value is 'A'.
    
    Returns:
    
    this MaskBuilder
  - appendUpperCase
```
public MaskBuilder appendUpperCase(char defaultValue)
```
    Appends a character where only upper case letter are allowed. Typing lower case character will set an upper case character.
    
    Parameters:
    
    defaultValue - the default value for each character
    
    Returns:
    
    this MaskBuilder
  - appendUpperCase
```
public MaskBuilder appendUpperCase(int repeat)
```
    Appends some characters where only upper case letter are allowed. Typing lower case character will set an upper case character. Default value is 'A'.
    
    Parameters:
    
    repeat - number of character to append
    
    Returns:
    
    this MaskBuilder
  - appendUpperCase
```
public MaskBuilder appendUpperCase(int repeat,
                                   char defaultValue)
```
    Appends some characters where only upper case letter are allowed. Typing lower case character will set an upper case character.
    
    Parameters:
    
    repeat - number of character to append
    
    defaultValue - the default value for each character
    
    Returns:
    
    this MaskBuilder
  - appendLowerCase
```
public MaskBuilder appendLowerCase()
```
    Appends a character where only lower case letter are allowed. Typing upper case character will set a lower case character. Default value is 'a'.
    
    Returns:
    
    this MaskBuilder
  - appendLowerCase
```
public MaskBuilder appendLowerCase(char defaultValue)
```
    Appends a character where only lower case letter are allowed. Typing upper case character will set a lower case character.
    
    Parameters:
    
    defaultValue - the default value for each character
    
    Returns:
    
    this MaskBuilder
  - appendLowerCase
```
public MaskBuilder appendLowerCase(int repeat)
```
    Appends some characters where only lower case letter are allowed. Typing upper case character will set a lower case character. Default value is 'a'.
    
    Parameters:
    
    repeat - number of character to append
    
    Returns:
    
    this MaskBuilder
  - appendLowerCase
```
public MaskBuilder appendLowerCase(int repeat,
                                   char defaultValue)
```
    Appends some characters where only lower case letter are allowed. Typing upper case character will set a lower case character.
    
    Parameters:
    
    repeat - number of character to append
    
    defaultValue - the default value for each character
    
    Returns:
    
    this MaskBuilder
  - appendLetter
```
public MaskBuilder appendLetter()
```
    Appends a character where only letter are allowed. Default value is 'a'.
    
    Returns:
    
    this MaskBuilder
  - appendLetter
```
public MaskBuilder appendLetter(char defaultValue)
```
    Appends a character where only letter are allowed.
    
    Parameters:
    
    defaultValue - the default value for each character
    
    Returns:
    
    this MaskBuilder
  - appendLetter
```
public MaskBuilder appendLetter(int repeat)
```
    Appends some characters where only letter are allowed. Default value is 'a'.
    
    Parameters:
    
    repeat - number of character to append
    
    Returns:
    
    this MaskBuilder
  - appendLetter
```
public MaskBuilder appendLetter(int repeat,
                                char defaultValue)
```
    Appends some characters where only letter are allowed.
    
    Parameters:
    
    repeat - number of character to append
    
    defaultValue - the default value for each character
    
    Returns:
    
    this MaskBuilder
  - appendLetterOrDigit
```
public MaskBuilder appendLetterOrDigit()
```
    Appends a character where only letter or digit are allowed. Default value is 'a'.
    
    Returns:
    
    this MaskBuilder
  - appendLetterOrDigit
```
public MaskBuilder appendLetterOrDigit(char defaultValue)
```
    Appends a character where only letter or digit are allowed.
    
    Parameters:
    
    defaultValue - the default value for each character
    
    Returns:
    
    this MaskBuilder
  - appendLetterOrDigit
```
public MaskBuilder appendLetterOrDigit(int repeat)
```
    Appends some characters where only letter or digit are allowed. Default value is 'a'.
    
    Parameters:
    
    repeat - number of character to append
    
    Returns:
    
    this MaskBuilder
  - appendLetterOrDigit
```
public MaskBuilder appendLetterOrDigit(int repeat,
                                       char defaultValue)
```
    Appends some characters where only letter or digit are allowed.
    
    Parameters:
    
    repeat - number of character to append
    
    defaultValue - the default value for each character
    
    Returns:
    
    this MaskBuilder
  - appendHexa
```
public MaskBuilder appendHexa()
```
    Appends a character where only hexadecimal are allowed. Typing lower case hexadecimal letter will set an upper case hexadecimal letter. Default value is 'a'.
    
    Returns:
    
    this MaskBuilder
  - appendHexa
```
public MaskBuilder appendHexa(char defaultValue)
```
    Appends a character where only hexadecimal are allowed. Typing lower case hexadecimal letter will set an upper case hexadecimal letter.
    
    Parameters:
    
    defaultValue - the default value for each character
    
    Returns:
    
    this MaskBuilder
  - appendHexa
```
public MaskBuilder appendHexa(int repeat)
```
    Appends some characters where only hexadecimal are allowed. Typing lower case hexadecimal letter will set an upper case hexadecimal letter. Default value is 'a'.
    
    Parameters:
    
    repeat - number of character to append
    
    Returns:
    
    this MaskBuilder
  - appendHexa
```
public MaskBuilder appendHexa(int repeat,
                              char defaultValue)
```
    Appends some characters where only hexadecimal are allowed. Typing lower case hexadecimal letter will set an upper case hexadecimal letter.
    
    Parameters:
    
    repeat - number of character to append
    
    defaultValue - the default value for each character
    
    Returns:
    
    this MaskBuilder
  - appendAny
```
public MaskBuilder appendAny()
```
    Appends a character where any character are allowed. Default value is ' '.
    
    Returns:
    
    this MaskBuilder
  - appendAny
```
public MaskBuilder appendAny(char defaultValue)
```
    Appends a character where any character are allowed.
    
    Parameters:
    
    defaultValue - the default value for each character
    
    Returns:
    
    this MaskBuilder
  - appendAny
```
public MaskBuilder appendAny(int repeat)
```
    Appends some characters where any character are allowed. Default value is ' '.
    
    Parameters:
    
    repeat - number of character to append
    
    Returns:
    
    this MaskBuilder
  - appendAny
```
public MaskBuilder appendAny(int repeat,
                             char defaultValue)
```
    Appends some characters where any character are allowed.
    
    Parameters:
    
    repeat - number of character to append
    
    defaultValue - the default value for each character
    
    Returns:
    
    this MaskBuilder
  - append
```
public MaskBuilder append(int repeat,
                          Predicate<Character> allowed,
                          char defaultValue)
```
    Appends some characters where allowing only character defined by the allowed predicate.
    
    Parameters:
    
    repeat - number of character to append
    
    allowed - Predicate called to allow characters
    
    defaultValue - the default value for each character
    
    Returns:
    
    this MaskBuilder
  - append
```
public MaskBuilder append(int repeat,
                          Predicate<Character> allowed,
                          UnaryOperator<Character> transformation,
                          char defaultValue)
```
    Appends some characters where allowing only character defined by the allowed predicate.
    
    Parameters:
    
    repeat - number of character to append
    
    allowed - Predicate called to allow characters
    
    transformation - transformation to apply to the input characters
    
    defaultValue - the default value for each character
    
    Returns:
    
    this MaskBuilder
  - append
```
public MaskBuilder append(MaskTextFilter.MaskCharacter maskCharacter)
```
    Appends a MaskTextFilter.MaskCharacter.
    
    Parameters:
    
    maskCharacter - the MaskTextFilter.MaskCharacter to append
    
    Returns:
    
    this MaskBuilder
  - append
```
public MaskBuilder append(int repeat,
                          MaskTextFilter.MaskCharacter maskCharacter)
```
    Appends some MaskTextFilter.MaskCharacter.
    
    Parameters:
    
    repeat - number of character to append
    
    maskCharacter - the MaskTextFilter.MaskCharacter to append
    
    Returns:
    
    this MaskBuilder
  - build
```
public MaskTextFilter.MaskCharacter[] build()
```
    Specified by:
    
    build in interface Builder<MaskTextFilter.MaskCharacter[]>

Class MaskBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MaskBuilder

Method Detail

newBuilder

appendLiteral

appendDigit

appendDigit

appendDigit

appendDigit

appendUpperCase

appendUpperCase

appendUpperCase

appendUpperCase

appendLowerCase

appendLowerCase

appendLowerCase

appendLowerCase

appendLetter

appendLetter

appendLetter

appendLetter

appendLetterOrDigit

appendLetterOrDigit

appendLetterOrDigit

appendLetterOrDigit

appendHexa

appendHexa

appendHexa

appendHexa

appendAny

appendAny

appendAny

appendAny

append

append

append

append

build