| | |
| | | * rule used for determining the correct order of values when sorting |
| | | * or processing range filters. |
| | | */ |
| | | @org.opends.server.types.PublicAPI( |
| | | stability=org.opends.server.types.StabilityLevel.VOLATILE, |
| | | mayInstantiate=false, |
| | | mayExtend=true, |
| | | mayInvoke=false) |
| | | public abstract class OrderingMatchingRule |
| | | extends MatchingRule<OrderingMatchingRuleCfg> |
| | | implements Comparator<byte[]>, Serializable |
| | | { |
| | | /** |
| | | * The serial version identifier required to satisfy the compiler |
| | | * because this class implements the |
| | | * <CODE>java.io.Serializable</CODE> interface. This value was |
| | | * generated using the <CODE>serialver</CODE> command-line utility |
| | | * included with the Java SDK. |
| | | * because this class implements the {@code java.io.Serializable} |
| | | * interface. This value was generated using the {@code serialver} |
| | | * command-line utility included with the Java SDK. |
| | | */ |
| | | private static final long serialVersionUID = -5322529685787024597L; |
| | | |
| | |
| | | * @param value2 The normalized form of the second value to |
| | | * compare. |
| | | * |
| | | * @return A negative integer if <CODE>value1</CODE> should come |
| | | * before <CODE>value2</CODE> in ascending order, a |
| | | * positive integer if <CODE>value1</CODE> should come |
| | | * after <CODE>value2</CODE> in ascending order, or zero if |
| | | * there is no difference between the values with regard to |
| | | * ordering. |
| | | * @return A negative integer if {@code value1} should come before |
| | | * {@code value2} in ascending order, a positive integer if |
| | | * {@code value1} should come after {@code value2} in |
| | | * ascending order, or zero if there is no difference |
| | | * between the values with regard to ordering. |
| | | */ |
| | | public abstract int compareValues(ByteString value1, |
| | | ByteString value2); |
| | |
| | | * <BR><BR> |
| | | * Note that ordering matching rules by default do not support |
| | | * extensible matching, and therefore this method will always return |
| | | * <CODE>UNDEFINED</CODE>. If an ordering matching rule does |
| | | * support extensible matching operations, then it should override |
| | | * this method and provide an appropriate implementation. |
| | | * {@code UNDEFINED}. If an ordering matching rule does support |
| | | * extensible matching operations, then it should override this |
| | | * method and provide an appropriate implementation. |
| | | * |
| | | * @param attributeValue The attribute value in a form that has |
| | | * been normalized according to this |
| | |
| | | * been normalized according to this |
| | | * matching rule. |
| | | * |
| | | * @return <CODE>true</CODE> if the attribute value should be |
| | | * considered a match for the provided assertion value, or |
| | | * <CODE>false</CODE> if not. |
| | | * @return {@code true} if the attribute value should be considered |
| | | * a match for the provided assertion value, or |
| | | * {@code false} if not. |
| | | */ |
| | | public ConditionResult valuesMatch(ByteString attributeValue, |
| | | ByteString assertionValue) |