Package org.forgerock.opendj.ldap

Interface Assertion

public interface Assertion

A compiled attribute value assertion.

Method Summary

Modifier and Type	Method	Description
<T> T	createIndexQuery(AttributeDescription attributeDescription, IndexQueryFactory<T> factory)	Returns an index query appropriate for the provided attribute value assertion.
default ConditionResult	matches(Attribute attribute)	Indicates whether the provided attribute should be considered a match for this assertion value according to the matching rule.
ConditionResult	matches(ByteString normalizedAttributeValue)	Indicates whether the provided attribute value should be considered a match for this assertion value according to the matching rule.

Method Detail

matches

default ConditionResult matches(Attribute attribute)

Indicates whether the provided attribute should be considered a match for this assertion value according to the matching rule. This method will only be called when the assertion is compatible with the attribute's equality matching rule. Thus, implementations can safely use normalized values exposed by the attribute via methods like Attribute.matchesAnyNormalizedValue(Predicate).

Parameters:

attribute - The attribute whose equality matching rule is compatible with this assertion.

Returns:

TRUE if the attribute should be considered a match for the provided assertion value, FALSE if it does not match, or UNDEFINED if the result is undefined.

matches

ConditionResult matches(ByteString normalizedAttributeValue)

Indicates whether the provided attribute value should be considered a match for this assertion value according to the matching rule.

Parameters:

normalizedAttributeValue - The normalized attribute value.

Returns:

TRUE if the attribute value should be considered a match for the provided assertion value, FALSE if it does not match, or UNDEFINED if the result is undefined.

createIndexQuery

<T> T createIndexQuery(AttributeDescription attributeDescription,
                       IndexQueryFactory<T> factory)
                throws DecodeException

Returns an index query appropriate for the provided attribute value assertion.

Type Parameters:

T - The type of index query created by the factory.

Parameters:

attributeDescription - The attribute description whose index should be queried.

factory - The index query factory which should be used to construct the index query.

Returns:

The index query appropriate for the provided attribute value assertion.

Throws:

DecodeException - If an error occurs while generating the index query.