com.ongres.scram.common.stringprep

Enum StringPreparations

java.lang.Object

java.lang.Enum<StringPreparations>

com.ongres.scram.common.stringprep.StringPreparations

All Implemented Interfaces:

StringPreparation, Serializable, Comparable<StringPreparations>

public enum StringPreparations
extends Enum<StringPreparations>
implements StringPreparation

Enum Constant Summary

Enum Constants

Enum Constant and Description
NO_PREPARATION Implementation of StringPreparation that performs no preparation.

Method Summary

Modifier and Type	Method and Description
protected abstract String	doNormalize(String value)
String	normalize(String value) Normalize a UTF-8 String according to this String Preparation rules.
static StringPreparations	valueOf(String name) Returns the enum constant of this type with the specified name.
static StringPreparations[]	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

NO_PREPARATION

public static final StringPreparations NO_PREPARATION

Implementation of StringPreparation that performs no preparation. Non US-ASCII characters will produce an exception. Even though the [RFC5802] is not very clear about it, this implementation will normalize non-printable US-ASCII characters similarly to what SaslPrep does (i.e., removing them).

Method Detail

values

public static StringPreparations[] 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 (StringPreparations c : StringPreparations.values())
    System.out.println(c);

Returns:

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

valueOf

public static StringPreparations 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

doNormalize

protected abstract String doNormalize(String value)
                               throws IllegalArgumentException

Throws:

IllegalArgumentException

normalize

public String normalize(String value)
                 throws IllegalArgumentException

Description copied from interface: StringPreparation

Normalize a UTF-8 String according to this String Preparation rules.

Specified by:

normalize in interface StringPreparation

Parameters:

value - The String to prepare

Returns:

The prepared String

Throws:

IllegalArgumentException - If the String to prepare is not valid.