@ThreadSafety(level=COMPLETELY_THREADSAFE) public final class CaseIgnoreListMatchingRule extends MatchingRule
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
EQUALITY_RULE_NAME
The name for the caseIgnoreListMatch equality matching rule.
|
static java.lang.String |
EQUALITY_RULE_OID
The OID for the caseIgnoreListMatch equality matching rule.
|
static java.lang.String |
SUBSTRING_RULE_NAME
The name for the caseIgnoreListSubstringsMatch substring matching rule.
|
static java.lang.String |
SUBSTRING_RULE_OID
The OID for the caseIgnoreListSubstringsMatch substring matching rule.
|
SUBSTRING_TYPE_SUBANY, SUBSTRING_TYPE_SUBFINAL, SUBSTRING_TYPE_SUBINITIAL
Constructor and Description |
---|
CaseIgnoreListMatchingRule()
Creates a new instance of this case-ignore list matching rule.
|
Modifier and Type | Method and 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 CaseIgnoreListMatchingRule |
getInstance()
Retrieves a singleton instance of this matching rule.
|
static java.util.List<java.lang.String> |
getItems(ASN1OctetString value)
Retrieves a list of the items contained in the provided value.
|
static java.util.List<java.lang.String> |
getItems(java.lang.String value)
Retrieves a list of the items contained in the provided value.
|
static java.util.List<java.lang.String> |
getLowercaseItems(ASN1OctetString value)
Retrieves a list of the lowercase representations of the items contained in
the provided value.
|
static java.util.List<java.lang.String> |
getLowercaseItems(java.lang.String value)
Retrieves a list of the lowercase representations of the items contained in
the provided value.
|
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.
|
boolean |
matchesSubstring(ASN1OctetString value,
ASN1OctetString subInitial,
ASN1OctetString[] subAny,
ASN1OctetString subFinal)
Indicates whether the provided value matches the given substring assertion,
according to the constraints of this matching rule.
|
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.
|
boolean |
valuesMatch(ASN1OctetString value1,
ASN1OctetString value2)
Indicates whether the provided values are equal to each other, according to
the constraints of this matching rule.
|
getDefaultEqualityMatchingRule, getDefaultOrderingMatchingRule, getDefaultSubstringMatchingRule, getEqualityMatchingRuleNameOrOID, getOrderingMatchingRuleNameOrOID, getSubstringMatchingRuleNameOrOID, matchesAnyValue, selectEqualityMatchingRule, selectEqualityMatchingRule, selectEqualityMatchingRule, selectMatchingRuleForSyntax, selectOrderingMatchingRule, selectOrderingMatchingRule, selectOrderingMatchingRule, selectSubstringMatchingRule, selectSubstringMatchingRule, selectSubstringMatchingRule
@NotNull public static final java.lang.String EQUALITY_RULE_NAME
@NotNull public static final java.lang.String EQUALITY_RULE_OID
@NotNull public static final java.lang.String SUBSTRING_RULE_NAME
@NotNull public static final java.lang.String SUBSTRING_RULE_OID
public CaseIgnoreListMatchingRule()
@NotNull public static CaseIgnoreListMatchingRule getInstance()
@NotNull public java.lang.String getEqualityMatchingRuleName()
getEqualityMatchingRuleName
in class MatchingRule
null
if this matching rule is not intended
to be used for equality matching.@NotNull public java.lang.String getEqualityMatchingRuleOID()
getEqualityMatchingRuleOID
in class MatchingRule
null
if this matching rule is not intended
to be used for equality matching.@Nullable public java.lang.String getOrderingMatchingRuleName()
getOrderingMatchingRuleName
in class MatchingRule
null
if this matching rule is not intended
to be used for ordering matching.@Nullable public java.lang.String getOrderingMatchingRuleOID()
getOrderingMatchingRuleOID
in class MatchingRule
null
if this matching rule is not intended
to be used for ordering matching.@NotNull public java.lang.String getSubstringMatchingRuleName()
getSubstringMatchingRuleName
in class MatchingRule
null
if this matching rule is not intended
to be used for substring matching.@NotNull public java.lang.String getSubstringMatchingRuleOID()
getSubstringMatchingRuleOID
in class MatchingRule
null
if this matching rule is not intended
to be used for substring matching.public boolean valuesMatch(@NotNull ASN1OctetString value1, @NotNull ASN1OctetString value2) throws LDAPException
valuesMatch
in class MatchingRule
value1
- The first value for which to make the determination.value2
- The second value for which to make the determination.true
if the provided values are considered equal, or
false
if not.LDAPException
- If a problem occurs while making the determination,
or if this matching rule does not support equality
matching.public boolean matchesSubstring(@NotNull ASN1OctetString value, @Nullable ASN1OctetString subInitial, @Nullable ASN1OctetString[] subAny, @Nullable ASN1OctetString subFinal) throws LDAPException
matchesSubstring
in class MatchingRule
value
- The value for which to make the determination.subInitial
- The subInitial portion of the substring assertion, or
null
if there is no subInitial element.subAny
- The subAny elements of the substring assertion, or
null
if there are no subAny elements.subFinal
- The subFinal portion of the substring assertion, or
null
if there is no subFinal element.true
if the provided value matches the substring
assertion, or false
if not.LDAPException
- If a problem occurs while making the determination,
or if this matching rule does not support substring
matching.public int compareValues(@NotNull ASN1OctetString value1, @NotNull ASN1OctetString value2) throws LDAPException
compareValues
in class MatchingRule
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.@NotNull public ASN1OctetString normalize(@NotNull ASN1OctetString value) throws LDAPException
normalize
in class MatchingRule
value
- The value to be normalized.LDAPException
- If a problem occurs while normalizing the provided
value.@NotNull public ASN1OctetString normalizeSubstring(@NotNull 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.@NotNull public static java.util.List<java.lang.String> getItems(@NotNull ASN1OctetString value) throws LDAPException
value
- The value for which to obtain the list of items. It must
not be null
.LDAPException
- If the provided value does not represent a valid
list in accordance with this matching rule.@NotNull public static java.util.List<java.lang.String> getItems(@NotNull java.lang.String value) throws LDAPException
value
- The value for which to obtain the list of items. It must
not be null
.LDAPException
- If the provided value does not represent a valid
list in accordance with this matching rule.@NotNull public static java.util.List<java.lang.String> getLowercaseItems(@NotNull ASN1OctetString value) throws LDAPException
value
- The value for which to obtain the list of items. It must
not be null
.LDAPException
- If the provided value does not represent a valid
list in accordance with this matching rule.@NotNull public static java.util.List<java.lang.String> getLowercaseItems(@NotNull java.lang.String value) throws LDAPException
value
- The value for which to obtain the list of items. It must
not be null
.LDAPException
- If the provided value does not represent a valid
list in accordance with this matching rule.