com.unboundid.directory.sdk.common.schema
Interface OrderingMatchingRule

All Superinterfaces:

MatchingRule

@NotExtensible
@ThreadSafety(level=INTERFACE_THREADSAFE)
public interface OrderingMatchingRule
extends MatchingRule

This interface provides an API for interacting with ordering matching rules, which can be used to determine the logical order of two values in a sorted list.

Method Summary

int	compareValues(ByteString normValue1, ByteString normValue2) Compares the provided values to determine their logical order in a sorted list.

Methods inherited from interface com.unboundid.directory.sdk.common.schema.MatchingRule

equals, getDescription, getName, getNameOrOID, getOID, getSyntaxOID, hashCode, hasNameOrOID, isObsolete, normalizeValue, toString, valuesMatch

Method Detail

compareValues

int compareValues(ByteString normValue1,
                  ByteString normValue2)

Compares the provided values to determine their logical order in a sorted list.

Parameters:

normValue1 - The normalized form of the first value for which to make the determination.

normValue2 - The normalized form of the second value for which to make the determination.

Returns:

A negative value if the first value should be ordered before the second, a positive value if the first value should be ordered after the second, or zero if there is no logical difference between the provided values.