Class TelephoneNumberMatchingRule

    • Constructor Detail

    • Method Detail

      • 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 class MatchingRule
        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 class MatchingRule
        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 class MatchingRule
        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 class MatchingRule
        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 class MatchingRule
        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 class MatchingRule
        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 class SimpleMatchingRule
        Parameters:
        value1 - The first value to compare.
        value2 - The second value to compare.
        Returns:
        A negative value if 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.
        Throws:
        LDAPException - If a problem occurs while making the determination, or if this matching rule does not support ordering matching.
      • 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 class MatchingRule
        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 of SUBSTRING_TYPE_SUBINITIAL, SUBSTRING_TYPE_SUBANY, or SUBSTRING_TYPE_SUBFINAL.
        Returns:
        The normalized form of the provided value.
        Throws:
        LDAPException - If a problem occurs while normalizing the provided value.