From f2160f4bd1c8ac67e5a86a6710d431e8932877f9 Mon Sep 17 00:00:00 2001
From: matthew_swift <matthew_swift@localhost>
Date: Fri, 28 May 2010 11:47:51 +0000
Subject: [PATCH] Synchronize SDK on java.net with internal repository.
---
sdk/src/org/opends/sdk/requests/CompareRequest.java | 171 +++++++++++++++++---------------------------------------
1 files changed, 52 insertions(+), 119 deletions(-)
diff --git a/sdk/src/org/opends/sdk/requests/CompareRequest.java b/sdk/src/org/opends/sdk/requests/CompareRequest.java
index 0fa70a1..c99b49a 100644
--- a/sdk/src/org/opends/sdk/requests/CompareRequest.java
+++ b/sdk/src/org/opends/sdk/requests/CompareRequest.java
@@ -29,36 +29,26 @@
-import org.opends.sdk.AttributeDescription;
-import org.opends.sdk.ByteString;
-import org.opends.sdk.DN;
-import org.opends.sdk.LocalizedIllegalArgumentException;
-import org.opends.sdk.controls.Control;
+import java.util.List;
+import org.opends.sdk.*;
+import org.opends.sdk.controls.Control;
+import org.opends.sdk.controls.ControlDecoder;
/**
- * The Compare operation allows a client to compare an assertion value
- * with the values of a particular attribute in a particular entry in
- * the Directory.
+ * The Compare operation allows a client to compare an assertion value with the
+ * values of a particular attribute in a particular entry in the Directory.
* <p>
- * Note that some directory systems may establish access controls that
- * permit the values of certain attributes (such as {@code userPassword}
- * ) to be compared but not interrogated by other means.
+ * Note that some directory systems may establish access controls that permit
+ * the values of certain attributes (such as {@code userPassword} ) to be
+ * compared but not interrogated by other means.
*/
public interface CompareRequest extends Request
{
/**
- * Adds the provided control to this request.
- *
- * @param control
- * The control to be added to this request.
- * @return This request.
- * @throws UnsupportedOperationException
- * If this request does not permit controls to be added.
- * @throws NullPointerException
- * If {@code control} was {@code null}.
+ * {@inheritDoc}
*/
CompareRequest addControl(Control control)
throws UnsupportedOperationException, NullPointerException;
@@ -66,19 +56,8 @@
/**
- * Removes all the controls included with this request.
- *
- * @return This request.
- * @throws UnsupportedOperationException
- * If this request does not permit controls to be removed.
- */
- CompareRequest clearControls() throws UnsupportedOperationException;
-
-
-
- /**
* Returns the assertion value to be compared.
- *
+ *
* @return The assertion value.
*/
ByteString getAssertionValue();
@@ -86,9 +65,8 @@
/**
- * Returns the assertion value to be compared decoded as a UTF-8
- * string.
- *
+ * Returns the assertion value to be compared decoded as a UTF-8 string.
+ *
* @return The assertion value decoded as a UTF-8 string.
*/
String getAssertionValueAsString();
@@ -97,7 +75,7 @@
/**
* Returns the name of the attribute to be compared.
- *
+ *
* @return The name of the attribute.
*/
AttributeDescription getAttributeDescription();
@@ -105,36 +83,24 @@
/**
- * Returns the first control contained in this request having the
- * specified OID.
- *
- * @param oid
- * The OID of the control to be returned.
- * @return The control, or {@code null} if the control is not included
- * with this request.
- * @throws NullPointerException
- * If {@code oid} was {@code null}.
+ * {@inheritDoc}
*/
- Control getControl(String oid) throws NullPointerException;
+ <C extends Control> C getControl(ControlDecoder<C> decoder,
+ DecodeOptions options) throws NullPointerException, DecodeException;
/**
- * Returns an {@code Iterable} containing the controls included with
- * this request. The returned {@code Iterable} may be used to remove
- * controls if permitted by this request.
- *
- * @return An {@code Iterable} containing the controls.
+ * {@inheritDoc}
*/
- Iterable<Control> getControls();
+ List<Control> getControls();
/**
- * Returns the distinguished name of the entry to be compared. The
- * server shall not dereference any aliases in locating the entry to
- * be compared.
- *
+ * Returns the distinguished name of the entry to be compared. The server
+ * shall not dereference any aliases in locating the entry to be compared.
+ *
* @return The distinguished name of the entry.
*/
DN getName();
@@ -142,42 +108,14 @@
/**
- * Indicates whether or not this request has any controls.
- *
- * @return {@code true} if this request has any controls, otherwise
- * {@code false}.
- */
- boolean hasControls();
-
-
-
- /**
- * Removes the first control contained in this request having the
- * specified OID.
- *
- * @param oid
- * The OID of the control to be removed.
- * @return The removed control, or {@code null} if the control is not
- * included with this request.
- * @throws UnsupportedOperationException
- * If this request does not permit controls to be removed.
- * @throws NullPointerException
- * If {@code oid} was {@code null}.
- */
- Control removeControl(String oid)
- throws UnsupportedOperationException, NullPointerException;
-
-
-
- /**
* Sets the assertion value to be compared.
- *
+ *
* @param value
* The assertion value to be compared.
* @return This compare request.
* @throws UnsupportedOperationException
- * If this compare request does not permit the assertion
- * value to be set.
+ * If this compare request does not permit the assertion value to be
+ * set.
* @throws NullPointerException
* If {@code value} was {@code null}.
*/
@@ -189,16 +127,15 @@
/**
* Sets the assertion value to be compared.
* <p>
- * If the assertion value is not an instance of {@code ByteString}
- * then it will be converted using the
- * {@link ByteString#valueOf(Object)} method.
- *
+ * If the assertion value is not an instance of {@code ByteString} then it
+ * will be converted using the {@link ByteString#valueOf(Object)} method.
+ *
* @param value
* The assertion value to be compared.
* @return This compare request.
* @throws UnsupportedOperationException
- * If this compare request does not permit the assertion
- * value to be set.
+ * If this compare request does not permit the assertion value to be
+ * set.
* @throws NullPointerException
* If {@code value} was {@code null}.
*/
@@ -209,13 +146,13 @@
/**
* Sets the name of the attribute to be compared.
- *
+ *
* @param attributeDescription
* The name of the attribute to be compared.
* @return This compare request.
* @throws UnsupportedOperationException
- * If this compare request does not permit the attribute
- * description to be set.
+ * If this compare request does not permit the attribute description
+ * to be set.
* @throws NullPointerException
* If {@code attributeDescription} was {@code null}.
*/
@@ -227,36 +164,35 @@
/**
* Sets the name of the attribute to be compared.
- *
+ *
* @param attributeDescription
* The name of the attribute to be compared.
* @return This compare request.
* @throws LocalizedIllegalArgumentException
- * If {@code attributeDescription} could not be decoded
- * using the default schema.
+ * If {@code attributeDescription} could not be decoded using the
+ * default schema.
* @throws UnsupportedOperationException
- * If this compare request does not permit the attribute
- * description to be set.
+ * If this compare request does not permit the attribute description
+ * to be set.
* @throws NullPointerException
* If {@code attributeDescription} was {@code null}.
*/
CompareRequest setAttributeDescription(String attributeDescription)
- throws LocalizedIllegalArgumentException,
- UnsupportedOperationException, NullPointerException;
+ throws LocalizedIllegalArgumentException, UnsupportedOperationException,
+ NullPointerException;
/**
- * Sets the distinguished name of the entry to be compared. The server
- * shall not dereference any aliases in locating the entry to be
- * compared.
- *
+ * Sets the distinguished name of the entry to be compared. The server shall
+ * not dereference any aliases in locating the entry to be compared.
+ *
* @param dn
* The distinguished name of the entry to be compared.
* @return This compare request.
* @throws UnsupportedOperationException
- * If this compare request does not permit the distinguished
- * name to be set.
+ * If this compare request does not permit the distinguished name to
+ * be set.
* @throws NullPointerException
* If {@code dn} was {@code null}.
*/
@@ -266,24 +202,21 @@
/**
- * Sets the distinguished name of the entry to be compared. The server
- * shall not dereference any aliases in locating the entry to be
- * compared.
- *
+ * Sets the distinguished name of the entry to be compared. The server shall
+ * not dereference any aliases in locating the entry to be compared.
+ *
* @param dn
* The distinguished name of the entry to be compared.
* @return This compare request.
* @throws LocalizedIllegalArgumentException
- * If {@code dn} could not be decoded using the default
- * schema.
+ * If {@code dn} could not be decoded using the default schema.
* @throws UnsupportedOperationException
- * If this compare request does not permit the distinguished
- * name to be set.
+ * If this compare request does not permit the distinguished name to
+ * be set.
* @throws NullPointerException
* If {@code dn} was {@code null}.
*/
- CompareRequest setName(String dn)
- throws LocalizedIllegalArgumentException,
+ CompareRequest setName(String dn) throws LocalizedIllegalArgumentException,
UnsupportedOperationException, NullPointerException;
}
--
Gitblit v1.10.0