com.github.mangstadt.vinnie.validate

Class AllowedCharacters.Builder

java.lang.Object

com.github.mangstadt.vinnie.validate.AllowedCharacters.Builder

Enclosing class:

AllowedCharacters

public static class AllowedCharacters.Builder
extends Object

Builder class for creating new instances of AllowedCharacters.

Constructor Summary

Constructors

Constructor and Description
Builder() Creates a new builder.
Builder(AllowedCharacters original) Initializes the builder with an existing AllowedCharacters object.

Method Summary

Modifier and Type	Method and Description
AllowedCharacters.Builder	allow(char c) Allow the given character.
AllowedCharacters.Builder	allow(int from, int to) Allow characters within the given range.
AllowedCharacters.Builder	allow(String characters) Allow all the characters in the given string.
AllowedCharacters.Builder	allowAll() Allow all characters.
AllowedCharacters.Builder	allowNonAscii() Allows all characters outside the range of 7-bit ASCII.
AllowedCharacters.Builder	allowPrintable() Allows all characters that are considered "printable" (32-126 inclusive).
AllowedCharacters	build() Constructs the final AllowedCharacters object.
AllowedCharacters.Builder	except(char c) Reject the given character.
AllowedCharacters.Builder	except(String characters) Reject all the characters in the given string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Creates a new builder.

Builder

public Builder(AllowedCharacters original)

Initializes the builder with an existing AllowedCharacters object.

Parameters:

original - the object to copy

Method Detail

allowAll

public AllowedCharacters.Builder allowAll()

Allow all characters.

Returns:

this

allow

public AllowedCharacters.Builder allow(int from,
                                       int to)

Allow characters within the given range.

Parameters:

from - the character to start at

to - the character to end at (inclusive)

Returns:

this

allow

public AllowedCharacters.Builder allow(String characters)

Allow all the characters in the given string.

Parameters:

characters - the string containing the allowable characters

Returns:

this

allow

public AllowedCharacters.Builder allow(char c)

Allow the given character.

Parameters:

c - the character

Returns:

this

allowPrintable

public AllowedCharacters.Builder allowPrintable()

Allows all characters that are considered "printable" (32-126 inclusive). This does NOT include tabs, carriage returns, or line feeds. This DOES include spaces.

Returns:

this

allowNonAscii

public AllowedCharacters.Builder allowNonAscii()

Allows all characters outside the range of 7-bit ASCII.

Returns:

this

except

public AllowedCharacters.Builder except(String characters)

Reject all the characters in the given string.

Parameters:

characters - the string containing the illegal characters

Returns:

this

except

public AllowedCharacters.Builder except(char c)

Reject the given character.

Parameters:

c - the character

Returns:

this

build

public AllowedCharacters build()

Constructs the final AllowedCharacters object.

Returns:

the object