org.passay

Enum EnglishSequenceData

java.lang.Object

java.lang.Enum<EnglishSequenceData>

org.passay.EnglishSequenceData

All Implemented Interfaces:

Serializable, Comparable<EnglishSequenceData>, SequenceData

public enum EnglishSequenceData
extends Enum<EnglishSequenceData>
implements SequenceData

English character sequences.

Author:

Middleware Services

Enum Constant Summary

Enum Constants

Enum Constant and Description
Alphabetical Alphabetical sequence.
Numerical Numerical sequence.
USQwerty US QWERTY keyboard sequence.

Method Summary

Modifier and Type	Method and Description
String	getErrorCode() Return the error code used for message resolution.
CharacterSequence[]	getSequences()
static EnglishSequenceData	valueOf(String name) Returns the enum constant of this type with the specified name.
static EnglishSequenceData[]	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 Detail

Alphabetical

public static final EnglishSequenceData Alphabetical

Alphabetical sequence.

Numerical

public static final EnglishSequenceData Numerical

Numerical sequence.

USQwerty

public static final EnglishSequenceData USQwerty

US QWERTY keyboard sequence.

Method Detail

values

public static EnglishSequenceData[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (EnglishSequenceData c : EnglishSequenceData.values())
    System.out.println(c);

Returns:

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

valueOf

public static EnglishSequenceData 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: SequenceData

Return the error code used for message resolution.

Specified by:

getErrorCode in interface SequenceData

Returns:

error code

getSequences

public CharacterSequence[] getSequences()

Specified by:

getSequences in interface SequenceData

Returns:

one or more illegal character sequences.