com.unboundid.ldap.matchingrules

Class OctetStringMatchingRule

java.lang.Object

com.unboundid.ldap.matchingrules.MatchingRule

com.unboundid.ldap.matchingrules.SimpleMatchingRule

com.unboundid.ldap.matchingrules.AcceptAllSimpleMatchingRule

com.unboundid.ldap.matchingrules.OctetStringMatchingRule

All Implemented Interfaces:

java.io.Serializable

@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class OctetStringMatchingRule
extends AcceptAllSimpleMatchingRule

This class provides an implementation of a matching rule that performs byte-for-byte matching.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EQUALITY_RULE_NAME The name for the octetStringMatch equality matching rule.
static java.lang.String	EQUALITY_RULE_OID The OID for the octetStringMatch equality matching rule.
static java.lang.String	ORDERING_RULE_NAME The name for the octetStringOrderingMatch ordering matching rule.
static java.lang.String	ORDERING_RULE_OID The OID for the octetStringOrderingMatch ordering matching rule.
static java.lang.String	SUBSTRING_RULE_NAME The name for the octetStringSubstringsMatch substring matching rule.
static java.lang.String	SUBSTRING_RULE_OID The OID for the octetStringSubstringMatch 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 and Description
OctetStringMatchingRule() Creates a new instance of this octet string matching rule.

Method Summary

Modifier and Type	Method and 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 OctetStringMatchingRule	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.AcceptAllSimpleMatchingRule

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EQUALITY_RULE_NAME

@NotNull
public static final java.lang.String EQUALITY_RULE_NAME

The name for the octetStringMatch 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 octetStringMatch 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 octetStringOrderingMatch 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 octetStringOrderingMatch 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 octetStringSubstringsMatch 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 octetStringSubstringMatch substring matching rule.

See Also:

Constant Field Values

Constructor Detail

OctetStringMatchingRule

public OctetStringMatchingRule()

Creates a new instance of this octet string matching rule.

Method Detail

getInstance

@NotNull
public static OctetStringMatchingRule 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 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

@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 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

@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 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

@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 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

@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 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

@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 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.

normalize

@NotNull
public ASN1OctetString normalize(@NotNull
                                          ASN1OctetString value)

Normalizes the provided value for easier matching. This variant of the normalize method is not allowed to throw exceptions.

Specified by:

normalize in class AcceptAllSimpleMatchingRule

Parameters:

value - The value to be normalized.

Returns:

The normalized form of the provided value.

normalizeSubstring

@NotNull
public ASN1OctetString normalizeSubstring(@NotNull
                                                   ASN1OctetString value,
                                                   byte substringType)

Normalizes the provided value for use as part of a substring assertion. This variant of the normalizeSubstring method is not allowed to throw exceptions.

Specified by:

normalizeSubstring in class AcceptAllSimpleMatchingRule

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.