Package com.unboundid.ldap.matchingrules
Class AcceptAllSimpleMatchingRule
- java.lang.Object
-
- com.unboundid.ldap.matchingrules.MatchingRule
-
- com.unboundid.ldap.matchingrules.SimpleMatchingRule
-
- com.unboundid.ldap.matchingrules.AcceptAllSimpleMatchingRule
-
- All Implemented Interfaces:
java.io.Serializable
- Direct Known Subclasses:
CaseExactStringMatchingRule
,CaseIgnoreStringMatchingRule
,OctetStringMatchingRule
@Extensible @ThreadSafety(level=INTERFACE_THREADSAFE) public abstract class AcceptAllSimpleMatchingRule extends SimpleMatchingRule
This class provides a common matching rule framework that may be extended by matching rule implementations in which equality, ordering, and substring matching can all be made based on byte-for-byte comparisons of the normalized value, and any value is acceptable.- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.unboundid.ldap.matchingrules.MatchingRule
SUBSTRING_TYPE_SUBANY, SUBSTRING_TYPE_SUBFINAL, SUBSTRING_TYPE_SUBINITIAL
-
-
Constructor Summary
Constructors Constructor Description AcceptAllSimpleMatchingRule()
-
Method Summary
All Methods Instance Methods Abstract 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.boolean
matchesAnyValue(ASN1OctetString assertionValue, ASN1OctetString[] attributeValues)
Indicates whether the provided assertion value matches any of the provided attribute values.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.abstract ASN1OctetString
normalize(ASN1OctetString value)
Normalizes the provided value for easier matching.abstract 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.-
Methods inherited from class com.unboundid.ldap.matchingrules.MatchingRule
getDefaultEqualityMatchingRule, getDefaultOrderingMatchingRule, getDefaultSubstringMatchingRule, getEqualityMatchingRuleName, getEqualityMatchingRuleNameOrOID, getEqualityMatchingRuleOID, getOrderingMatchingRuleName, getOrderingMatchingRuleNameOrOID, getOrderingMatchingRuleOID, getSubstringMatchingRuleName, getSubstringMatchingRuleNameOrOID, getSubstringMatchingRuleOID, selectEqualityMatchingRule, selectEqualityMatchingRule, selectEqualityMatchingRule, selectMatchingRuleForSyntax, selectOrderingMatchingRule, selectOrderingMatchingRule, selectOrderingMatchingRule, selectSubstringMatchingRule, selectSubstringMatchingRule, selectSubstringMatchingRule
-
-
-
-
Constructor Detail
-
AcceptAllSimpleMatchingRule
public AcceptAllSimpleMatchingRule()
-
-
Method Detail
-
valuesMatch
public boolean valuesMatch(ASN1OctetString value1, ASN1OctetString value2)
Indicates whether the provided values are equal to each other, according to the constraints of this matching rule.- Overrides:
valuesMatch
in classSimpleMatchingRule
- Parameters:
value1
- The first value for which to make the determination.value2
- The second value for which to make the determination.- Returns:
true
if the provided values are considered equal, orfalse
if not.
-
matchesAnyValue
public boolean matchesAnyValue(ASN1OctetString assertionValue, ASN1OctetString[] attributeValues)
Indicates whether the provided assertion value matches any of the provided attribute values.- Overrides:
matchesAnyValue
in classSimpleMatchingRule
- Parameters:
assertionValue
- The assertion value for which to make the determination.attributeValues
- The set of attribute values to compare against the provided assertion value.- Returns:
true
if the provided assertion value matches any of the given attribute values, orfalse
if not.
-
matchesSubstring
public 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.- Overrides:
matchesSubstring
in classSimpleMatchingRule
- Parameters:
value
- The value for which to make the determination.subInitial
- The subInitial portion of the substring assertion, ornull
if there is no subInitial element.subAny
- The subAny elements of the substring assertion, ornull
if there are no subAny elements.subFinal
- The subFinal portion of the substring assertion, ornull
if there is no subFinal element.- Returns:
true
if the provided value matches the substring assertion, orfalse
if not.
-
compareValues
public int compareValues(ASN1OctetString value1, ASN1OctetString value2)
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.
-
normalize
public abstract ASN1OctetString normalize(ASN1OctetString value)
Normalizes the provided value for easier matching. This variant of thenormalize
method is not allowed to throw exceptions.- Specified by:
normalize
in classMatchingRule
- Parameters:
value
- The value to be normalized.- Returns:
- The normalized form of the provided value.
-
normalizeSubstring
public abstract ASN1OctetString normalizeSubstring(ASN1OctetString value, byte substringType)
Normalizes the provided value for use as part of a substring assertion. This variant of thenormalizeSubstring
method is not allowed to throw exceptions.- 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.
-
-