|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.matchingrules.MatchingRule
com.unboundid.ldap.matchingrules.SimpleMatchingRule
com.unboundid.ldap.matchingrules.TelephoneNumberMatchingRule
public final class TelephoneNumberMatchingRule
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.
Field Summary | |
---|---|
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 | |
---|---|
TelephoneNumberMatchingRule()
Creates a new instance of this telephone number matching rule. |
Method Summary | |
---|---|
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 |
---|
matchesSubstring, valuesMatch |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String EQUALITY_RULE_NAME
public static final java.lang.String EQUALITY_RULE_OID
public static final java.lang.String SUBSTRING_RULE_NAME
public static final java.lang.String SUBSTRING_RULE_OID
Constructor Detail |
---|
public TelephoneNumberMatchingRule()
Method Detail |
---|
public static TelephoneNumberMatchingRule getInstance()
public java.lang.String getEqualityMatchingRuleName()
getEqualityMatchingRuleName
in class MatchingRule
null
if this matching rule is not intended
to be used for equality matching.public java.lang.String getEqualityMatchingRuleOID()
getEqualityMatchingRuleOID
in class MatchingRule
null
if this matching rule is not intended
to be used for equality matching.public java.lang.String getOrderingMatchingRuleName()
getOrderingMatchingRuleName
in class MatchingRule
null
if this matching rule is not intended
to be used for ordering matching.public java.lang.String getOrderingMatchingRuleOID()
getOrderingMatchingRuleOID
in class MatchingRule
null
if this matching rule is not intended
to be used for ordering matching.public java.lang.String getSubstringMatchingRuleName()
getSubstringMatchingRuleName
in class MatchingRule
null
if this matching rule is not intended
to be used for substring matching.public java.lang.String getSubstringMatchingRuleOID()
getSubstringMatchingRuleOID
in class MatchingRule
null
if this matching rule is not intended
to be used for substring matching.public int compareValues(ASN1OctetString value1, ASN1OctetString value2) throws LDAPException
compareValues
in class SimpleMatchingRule
value1
- The first value to compare.value2
- The second value to compare.
value1
should come before
value2
in a sorted list, a positive value if
value1
should come after value2
in a sorted list,
or zero if the values are equal or there is no distinction between
their orders in a sorted list.
LDAPException
- If a problem occurs while making the determination,
or if this matching rule does not support ordering
matching.public ASN1OctetString normalize(ASN1OctetString value) throws LDAPException
normalize
in class MatchingRule
value
- The value to be normalized.
LDAPException
- If a problem occurs while normalizing the provided
value.public ASN1OctetString normalizeSubstring(ASN1OctetString value, byte substringType) throws LDAPException
normalizeSubstring
in class MatchingRule
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 of
SUBSTRING_TYPE_SUBINITIAL
,
SUBSTRING_TYPE_SUBANY
, or
SUBSTRING_TYPE_SUBFINAL
.
LDAPException
- If a problem occurs while normalizing the provided
value.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |