From 22094368c2865dcfb6daf8366425212b721a4657 Mon Sep 17 00:00:00 2001
From: matthew_swift <matthew_swift@localhost>
Date: Thu, 05 Feb 2009 17:42:14 +0000
Subject: [PATCH] Merge ASN1 branch to trunk
---
opends/src/server/org/opends/server/api/ExtensibleMatchingRule.java | 64 ++++++++++++++++++--------------
1 files changed, 36 insertions(+), 28 deletions(-)
diff --git a/opends/src/server/org/opends/server/api/ExtensibleMatchingRule.java b/opends/src/server/org/opends/server/api/ExtensibleMatchingRule.java
index 798da0d..4c54a99 100644
--- a/opends/src/server/org/opends/server/api/ExtensibleMatchingRule.java
+++ b/opends/src/server/org/opends/server/api/ExtensibleMatchingRule.java
@@ -26,51 +26,59 @@
*/
package org.opends.server.api;
+
+
import java.util.Collection;
-import org.opends.server.types.ByteString;
+
+import org.opends.server.types.ByteSequence;
import org.opends.server.types.DirectoryException;
import org.opends.server.types.IndexConfig;
+
/**
* This class defines the set of methods and structures that must be
* implemented by a Directory Server module that implements an
* Extensible matching rule.
*/
@org.opends.server.types.PublicAPI(
- stability=org.opends.server.types.StabilityLevel.VOLATILE,
- mayInstantiate=false,
- mayExtend=true,
- mayInvoke=false)
+ stability = org.opends.server.types.StabilityLevel.VOLATILE,
+ mayInstantiate = false,
+ mayExtend = true,
+ mayInvoke = false)
public abstract class ExtensibleMatchingRule extends MatchingRule
{
/**
- * Returns a collection of extensible indexers associated with this
- * matching rule.
- * @param config The index configuration to be used by this
- * matching rule.
- * @return ExtensibleIndexer associated with this matching rule.
- */
- public abstract Collection<ExtensibleIndexer> getIndexers(
- IndexConfig config);
-
+ * Returns a collection of extensible indexers associated with this
+ * matching rule.
+ *
+ * @param config
+ * The index configuration to be used by this matching
+ * rule.
+ * @return The collection of extensible indexers associated with
+ * this matching rule.
+ */
+ public abstract Collection<ExtensibleIndexer> getIndexers(
+ IndexConfig config);
/**
- * Queries the index using factory of type T and returns
- * a query of type T for the provided assertion value.
- * @param <T> The type of IndexQueryFactory.
- * @param assertionValue An assertion value which needs to be
- * queried.
- * @param factory An IndexQueryFactory which will be used for
- * creating queries.
- * @return T The generated index query.
- * @throws DirectoryException If an error occurs while generating
- * the query.
+ * Returns an index query appropriate for the provided attribute
+ * value assertion.
+ *
+ * @param <T>
+ * The type of index query created by the {@code factory}.
+ * @param assertionValue
+ * The attribute value assertion.
+ * @param factory
+ * The index query factory which should be used to
+ * construct the index query.
+ * @return The index query appropriate for the provided attribute
+ * value assertion.
+ * @throws DirectoryException
+ * If an error occurs while generating the index query.
*/
- public abstract <T> T createIndexQuery(
- ByteString assertionValue,
- IndexQueryFactory<T> factory)
- throws DirectoryException;
+ public abstract <T> T createIndexQuery(ByteSequence assertionValue,
+ IndexQueryFactory<T> factory) throws DirectoryException;
}
\ No newline at end of file
--
Gitblit v1.10.0