com.unboundid.ldap.matchingrules

Enum TelephoneNumberComparisonPolicy

java.lang.Object

java.lang.Enum<TelephoneNumberComparisonPolicy>

com.unboundid.ldap.matchingrules.TelephoneNumberComparisonPolicy

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TelephoneNumberComparisonPolicy>

@ThreadSafety(level=COMPLETELY_THREADSAFE)
public enum TelephoneNumberComparisonPolicy
extends java.lang.Enum<TelephoneNumberComparisonPolicy>

This enum defines the policy that the TelephoneNumberMatchingRule should use when comparing two values in accordance with this syntax.

Enum Constant Summary

Enum Constants

Enum Constant and Description
IGNORE_ALL_NON_NUMERIC_CHARACTERS A policy that indicates that all non-numeric characters should be ignored when comparing values.
IGNORE_ONLY_SPACES_AND_DASHES A policy that indicates that only spaces and hyphens should be ignored when comparing values.

Method Summary

Modifier and Type	Method and Description
ASN1OctetString	normalizeValue(ASN1OctetString value) Normalizes the provided value in accordance with this policy.
static TelephoneNumberComparisonPolicy	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TelephoneNumberComparisonPolicy[]	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

IGNORE_ALL_NON_NUMERIC_CHARACTERS

public static final TelephoneNumberComparisonPolicy IGNORE_ALL_NON_NUMERIC_CHARACTERS

A policy that indicates that all non-numeric characters should be ignored when comparing values.

IGNORE_ONLY_SPACES_AND_DASHES

public static final TelephoneNumberComparisonPolicy IGNORE_ONLY_SPACES_AND_DASHES

A policy that indicates that only spaces and hyphens should be ignored when comparing values.

Method Detail

values

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

Returns:

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

valueOf

public static TelephoneNumberComparisonPolicy valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

normalizeValue

@NotNull
public ASN1OctetString normalizeValue(@NotNull
                                               ASN1OctetString value)

Normalizes the provided value in accordance with this policy. This method does not perform any validation on the provided value.

Parameters:

value - The value to be normalized. It must not be null.

Returns:

The normalized representation of the provided value.