Package com.unboundid.ldap.matchingrules
Class TelephoneNumberMatchingRule
- java.lang.Object
-
- com.unboundid.ldap.matchingrules.MatchingRule
-
- com.unboundid.ldap.matchingrules.SimpleMatchingRule
-
- com.unboundid.ldap.matchingrules.TelephoneNumberMatchingRule
-
- All Implemented Interfaces:
java.io.Serializable
@ThreadSafety(level=COMPLETELY_THREADSAFE) public final class TelephoneNumberMatchingRule extends SimpleMatchingRule
This class provides an implementation of a matching rule that may be used for telephone numbers. It will accept values with any ASCII printable character. When making comparisons, spaces and dashes will be ignored.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
EQUALITY_RULE_NAME
The name for the telephoneNumberMatch equality matching rule.static java.lang.String
EQUALITY_RULE_OID
The OID for the telephoneNumberMatch equality matching rule.static java.lang.String
SUBSTRING_RULE_NAME
The name for the telephoneNumberSubstringsMatch substring matching rule.static java.lang.String
SUBSTRING_RULE_OID
The OID for the telephoneNumberSubstringsMatch substring matching rule.-
Fields inherited from class com.unboundid.ldap.matchingrules.MatchingRule
SUBSTRING_TYPE_SUBANY, SUBSTRING_TYPE_SUBFINAL, SUBSTRING_TYPE_SUBINITIAL
-
-
Constructor Summary
Constructors Constructor Description TelephoneNumberMatchingRule()
Creates a new instance of this telephone number matching rule.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compareValues(ASN1OctetString value1, ASN1OctetString value2)
Compares the provided values to determine their relative order in a sorted list.java.lang.String
getEqualityMatchingRuleName()
Retrieves the name for this matching rule when used to perform equality matching, if appropriate.java.lang.String
getEqualityMatchingRuleOID()
Retrieves the OID for this matching rule when used to perform equality matching, if appropriate.static TelephoneNumberMatchingRule
getInstance()
Retrieves a singleton instance of this matching rule.java.lang.String
getOrderingMatchingRuleName()
Retrieves the name for this matching rule when used to perform ordering matching, if appropriate.java.lang.String
getOrderingMatchingRuleOID()
Retrieves the OID for this matching rule when used to perform ordering matching, if appropriate.java.lang.String
getSubstringMatchingRuleName()
Retrieves the name for this matching rule when used to perform substring matching, if appropriate.java.lang.String
getSubstringMatchingRuleOID()
Retrieves the OID for this matching rule when used to perform substring matching, if appropriate.ASN1OctetString
normalize(ASN1OctetString value)
Normalizes the provided value for easier matching.ASN1OctetString
normalizeSubstring(ASN1OctetString value, byte substringType)
Normalizes the provided value for use as part of a substring assertion.-
Methods inherited from class com.unboundid.ldap.matchingrules.SimpleMatchingRule
matchesAnyValue, matchesSubstring, valuesMatch
-
Methods inherited from class com.unboundid.ldap.matchingrules.MatchingRule
getDefaultEqualityMatchingRule, getDefaultOrderingMatchingRule, getDefaultSubstringMatchingRule, getEqualityMatchingRuleNameOrOID, getOrderingMatchingRuleNameOrOID, getSubstringMatchingRuleNameOrOID, selectEqualityMatchingRule, selectEqualityMatchingRule, selectEqualityMatchingRule, selectMatchingRuleForSyntax, selectOrderingMatchingRule, selectOrderingMatchingRule, selectOrderingMatchingRule, selectSubstringMatchingRule, selectSubstringMatchingRule, selectSubstringMatchingRule
-
-
-
-
Field Detail
-
EQUALITY_RULE_NAME
public static final java.lang.String EQUALITY_RULE_NAME
The name for the telephoneNumberMatch equality matching rule.- See Also:
- Constant Field Values
-
EQUALITY_RULE_OID
public static final java.lang.String EQUALITY_RULE_OID
The OID for the telephoneNumberMatch equality matching rule.- See Also:
- Constant Field Values
-
SUBSTRING_RULE_NAME
public static final java.lang.String SUBSTRING_RULE_NAME
The name for the telephoneNumberSubstringsMatch substring matching rule.- See Also:
- Constant Field Values
-
SUBSTRING_RULE_OID
public static final java.lang.String SUBSTRING_RULE_OID
The OID for the telephoneNumberSubstringsMatch substring matching rule.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
TelephoneNumberMatchingRule
public TelephoneNumberMatchingRule()
Creates a new instance of this telephone number matching rule.
-
-
Method Detail
-
getInstance
public static TelephoneNumberMatchingRule getInstance()
Retrieves a singleton instance of this matching rule.- Returns:
- A singleton instance of this matching rule.
-
getEqualityMatchingRuleName
public java.lang.String getEqualityMatchingRuleName()
Retrieves the name for this matching rule when used to perform equality matching, if appropriate.- Specified by:
getEqualityMatchingRuleName
in classMatchingRule
- Returns:
- The name for this matching rule when used to perform equality
matching, or
null
if this matching rule is not intended to be used for equality matching.
-
getEqualityMatchingRuleOID
public java.lang.String getEqualityMatchingRuleOID()
Retrieves the OID for this matching rule when used to perform equality matching, if appropriate.- Specified by:
getEqualityMatchingRuleOID
in classMatchingRule
- Returns:
- The OID for this matching rule when used to perform equality
matching, or
null
if this matching rule is not intended to be used for equality matching.
-
getOrderingMatchingRuleName
public java.lang.String getOrderingMatchingRuleName()
Retrieves the name for this matching rule when used to perform ordering matching, if appropriate.- Specified by:
getOrderingMatchingRuleName
in classMatchingRule
- Returns:
- The name for this matching rule when used to perform ordering
matching, or
null
if this matching rule is not intended to be used for ordering matching.
-
getOrderingMatchingRuleOID
public java.lang.String getOrderingMatchingRuleOID()
Retrieves the OID for this matching rule when used to perform ordering matching, if appropriate.- Specified by:
getOrderingMatchingRuleOID
in classMatchingRule
- Returns:
- The OID for this matching rule when used to perform ordering
matching, or
null
if this matching rule is not intended to be used for ordering matching.
-
getSubstringMatchingRuleName
public java.lang.String getSubstringMatchingRuleName()
Retrieves the name for this matching rule when used to perform substring matching, if appropriate.- Specified by:
getSubstringMatchingRuleName
in classMatchingRule
- Returns:
- The name for this matching rule when used to perform substring
matching, or
null
if this matching rule is not intended to be used for substring matching.
-
getSubstringMatchingRuleOID
public java.lang.String getSubstringMatchingRuleOID()
Retrieves the OID for this matching rule when used to perform substring matching, if appropriate.- Specified by:
getSubstringMatchingRuleOID
in classMatchingRule
- Returns:
- The OID for this matching rule when used to perform substring
matching, or
null
if this matching rule is not intended to be used for substring matching.
-
compareValues
public int compareValues(ASN1OctetString value1, ASN1OctetString value2) throws LDAPException
Compares the provided values to determine their relative order in a sorted list.- Overrides:
compareValues
in classSimpleMatchingRule
- Parameters:
value1
- The first value to compare.value2
- The second value to compare.- Returns:
- A negative value if
value1
should come beforevalue2
in a sorted list, a positive value ifvalue1
should come aftervalue2
in a sorted list, or zero if the values are equal or there is no distinction between their orders in a sorted list. - Throws:
LDAPException
- If a problem occurs while making the determination, or if this matching rule does not support ordering matching.
-
normalize
public ASN1OctetString normalize(ASN1OctetString value) throws LDAPException
Normalizes the provided value for easier matching.- Specified by:
normalize
in classMatchingRule
- Parameters:
value
- The value to be normalized.- Returns:
- The normalized form of the provided value.
- Throws:
LDAPException
- If a problem occurs while normalizing the provided value.
-
normalizeSubstring
public ASN1OctetString normalizeSubstring(ASN1OctetString value, byte substringType) throws LDAPException
Normalizes the provided value for use as part of a substring assertion.- Specified by:
normalizeSubstring
in classMatchingRule
- Parameters:
value
- The value to be normalized for use as part of a substring assertion.substringType
- The substring assertion component type for the provided value. It should be one ofSUBSTRING_TYPE_SUBINITIAL
,SUBSTRING_TYPE_SUBANY
, orSUBSTRING_TYPE_SUBFINAL
.- Returns:
- The normalized form of the provided value.
- Throws:
LDAPException
- If a problem occurs while normalizing the provided value.
-
-