Package com.unboundid.ldap.matchingrules
Class NumericStringMatchingRule
- java.lang.Object
-
- com.unboundid.ldap.matchingrules.MatchingRule
-
- com.unboundid.ldap.matchingrules.SimpleMatchingRule
-
- com.unboundid.ldap.matchingrules.NumericStringMatchingRule
-
- All Implemented Interfaces:
java.io.Serializable
@ThreadSafety(level=COMPLETELY_THREADSAFE) public final class NumericStringMatchingRule extends SimpleMatchingRule
This class provides an implementation of a matching rule that allows strings consisting of numeric digits and spaces. Spaces will be considered insignificant for matching purposes.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
EQUALITY_RULE_NAME
The name for the numericStringMatch equality matching rule.static java.lang.String
EQUALITY_RULE_OID
The OID for the numericStringMatch equality matching rule.static java.lang.String
ORDERING_RULE_NAME
The name for the numericStringOrderingMatch ordering matching rule.static java.lang.String
ORDERING_RULE_OID
The OID for the numericStringOrderingMatch ordering matching rule.static java.lang.String
SUBSTRING_RULE_NAME
The name for the numericStringSubstringsMatch substring matching rule.static java.lang.String
SUBSTRING_RULE_OID
The OID for the numericStringSubstringsMatch 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 NumericStringMatchingRule()
Creates a new instance of this numeric string matching rule.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description 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 NumericStringMatchingRule
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
compareValues, 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
@NotNull public static final java.lang.String EQUALITY_RULE_NAME
The name for the numericStringMatch equality matching rule.- See Also:
- Constant Field Values
-
EQUALITY_RULE_OID
@NotNull public static final java.lang.String EQUALITY_RULE_OID
The OID for the numericStringMatch equality matching rule.- See Also:
- Constant Field Values
-
ORDERING_RULE_NAME
@NotNull public static final java.lang.String ORDERING_RULE_NAME
The name for the numericStringOrderingMatch ordering matching rule.- See Also:
- Constant Field Values
-
ORDERING_RULE_OID
@NotNull public static final java.lang.String ORDERING_RULE_OID
The OID for the numericStringOrderingMatch ordering matching rule.- See Also:
- Constant Field Values
-
SUBSTRING_RULE_NAME
@NotNull public static final java.lang.String SUBSTRING_RULE_NAME
The name for the numericStringSubstringsMatch substring matching rule.- See Also:
- Constant Field Values
-
SUBSTRING_RULE_OID
@NotNull public static final java.lang.String SUBSTRING_RULE_OID
The OID for the numericStringSubstringsMatch substring matching rule.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
NumericStringMatchingRule
public NumericStringMatchingRule()
Creates a new instance of this numeric string matching rule.
-
-
Method Detail
-
getInstance
@NotNull public static NumericStringMatchingRule getInstance()
Retrieves a singleton instance of this matching rule.- Returns:
- A singleton instance of this matching rule.
-
getEqualityMatchingRuleName
@NotNull 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
@NotNull 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
@NotNull 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
@NotNull 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
@NotNull 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
@NotNull 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.
-
normalize
@NotNull public ASN1OctetString normalize(@NotNull 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
@NotNull public ASN1OctetString normalizeSubstring(@NotNull 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.
-
-