com.github.mangstadt.vinnie.validate

Class AllowedCharacters

java.lang.Object

com.github.mangstadt.vinnie.validate.AllowedCharacters

public class AllowedCharacters
extends Object

Validates whether or not strings contain only certain characters.

Author:

Michael Angstadt

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AllowedCharacters.Builder Builder class for creating new instances of AllowedCharacters.

Constructor Summary

Constructors

Constructor and Description
AllowedCharacters(BitSet bitSet, boolean allowNonAscii) Creates an allowed character list based on the given BitSet.

Method Summary

Modifier and Type	Method and Description
BitSet	bitSet() Gets the underlying BitSet object.
boolean	check(String string) Determines if a string only contains allowed characters.
AllowedCharacters	flip() Returns an allowed character list that is the opposite of this allowed character list (in other words, characters that are NOT allowed).
boolean	isNonAsciiAllowed() Determines if this allowed character list permits characters that are not part of 7-bit ASCII (character codes greater than 127).
String	toString() Generates a string representation of this allowed character list.
String	toString(boolean printableOnly) Generates a string representation of this allowed character list.

Methods inherited from class java.lang.Object

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

Constructor Detail

AllowedCharacters

public AllowedCharacters(BitSet bitSet,
                         boolean allowNonAscii)

Creates an allowed character list based on the given BitSet.

Parameters:

bitSet - the bit set

allowNonAscii - true to allow characters outside of the 7-bit ASCII character set (character codes greater than 127), false to only allow 7-bit ASCII

Method Detail

bitSet

public BitSet bitSet()

Gets the underlying BitSet object.

Returns:

the BitSet object

isNonAsciiAllowed

public boolean isNonAsciiAllowed()

Determines if this allowed character list permits characters that are not part of 7-bit ASCII (character codes greater than 127).

Returns:

true if non-ASCII characters are allowed, false if not

check

public boolean check(String string)

Determines if a string only contains allowed characters.

Parameters:

string - the string

Returns:

true if the string only contains allowed characters, false if not

flip

public AllowedCharacters flip()

Returns an allowed character list that is the opposite of this allowed character list (in other words, characters that are NOT allowed).

Returns:

the reverse list

toString

public String toString()

Generates a string representation of this allowed character list. Non-printable characters are represented by their character codes.

Overrides:

toString in class Object

Returns:

the string

toString

public String toString(boolean printableOnly)

Generates a string representation of this allowed character list. Non-printable characters are represented by their character codes.

Parameters:

printableOnly - true to only include printable characters in the string, false to include all characters

Returns:

the string