Enum Class StringPreparations

java.lang.Object
java.lang.Enum<StringPreparations>
com.ongres.scram.common.stringprep.StringPreparations
All Implemented Interfaces:
StringPreparation, Serializable, Comparable<StringPreparations>, Constable

public enum StringPreparations extends Enum<StringPreparations> implements StringPreparation
  • Enum Constant Details

    • 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).
    • SASL_PREPARATION

      public static final StringPreparations SASL_PREPARATION
      Implementation of StringPreparation that performs preparation. Non US-ASCII characters will produce an exception. Even though the [RFC5802] is not very clear about it, this implementation will normalize as SaslPrep does.
  • Constructor Details

    • StringPreparations

      private StringPreparations()
  • Method Details

    • values

      public static StringPreparations[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static StringPreparations valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class 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.