Package org.passay.data

Enum EnglishCharacterData

java.lang.Object

java.lang.Enum<EnglishCharacterData>

org.passay.data.EnglishCharacterData

All Implemented Interfaces:

Serializable, Comparable<EnglishCharacterData>, CharacterData

public enum EnglishCharacterData
extends Enum<EnglishCharacterData>
implements CharacterData

English language character data.

Enum Constant Summary

Enum Constants

Enum Constant	Description
Alphabetical	Alphabetical characters (upper and lower case).
Digit	Digit characters.
LowerCase	Lower case characters.
Special	Special characters.
SpecialAscii	Special ascii characters.
SpecialLatin	Special latin characters.
SpecialUnicode	Special unicode characters.
UpperCase	Upper case characters.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	characters	Characters.
private final String	errorCode	Error code.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	EnglishCharacterData(String code, String charString)	Creates a new english character data.

Method Summary

Modifier and Type	Method	Description
String	getCharacters()	Returns the characters.
String	getErrorCode()	Return the error code used for message resolution.
static EnglishCharacterData	valueOf(String name)	Returns the enum constant of this type with the specified name.
static EnglishCharacterData[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

LowerCase

public static final EnglishCharacterData LowerCase

Lower case characters.

UpperCase

public static final EnglishCharacterData UpperCase

Upper case characters.

Digit

public static final EnglishCharacterData Digit

Digit characters.

Alphabetical

public static final EnglishCharacterData Alphabetical

Alphabetical characters (upper and lower case).

SpecialAscii

public static final EnglishCharacterData SpecialAscii

Special ascii characters.

SpecialUnicode

public static final EnglishCharacterData SpecialUnicode

Special unicode characters.

SpecialLatin

public static final EnglishCharacterData SpecialLatin

Special latin characters.

Special

public static final EnglishCharacterData Special

Special characters.

Field Details

errorCode

private final String errorCode

Error code.

characters

private final String characters

Characters.

Constructor Details

EnglishCharacterData

private EnglishCharacterData(String code,
 String charString)

Creates a new english character data.

Parameters:

code - Error code.

charString - Characters as string.

Method Details

values

public static EnglishCharacterData[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static EnglishCharacterData valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getErrorCode

public String getErrorCode()

Description copied from interface: CharacterData

Return the error code used for message resolution.

Specified by:

getErrorCode in interface CharacterData

Returns:

error code

getCharacters

public String getCharacters()

Description copied from interface: CharacterData

Returns the characters.

Specified by:

getCharacters in interface CharacterData

Returns:

characters