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/responses/Result.java | 176 ++++++++++++++++++++++------------------------------------
1 files changed, 68 insertions(+), 108 deletions(-)
diff --git a/sdk/src/org/opends/sdk/responses/Result.java b/sdk/src/org/opends/sdk/responses/Result.java
index ad339e2..24ecd02 100644
--- a/sdk/src/org/opends/sdk/responses/Result.java
+++ b/sdk/src/org/opends/sdk/responses/Result.java
@@ -29,31 +29,36 @@
+import java.util.List;
+
+import org.opends.sdk.DecodeException;
+import org.opends.sdk.DecodeOptions;
import org.opends.sdk.ResultCode;
import org.opends.sdk.controls.Control;
+import org.opends.sdk.controls.ControlDecoder;
/**
- * A Result is used to indicate the status of an operation performed by
- * the server. A Result is comprised of several fields:
+ * A Result is used to indicate the status of an operation performed by the
+ * server. A Result is comprised of several fields:
* <ul>
* <li>The <b>result code</b> can be retrieved using the method
- * {@link #getResultCode}. This indicates the overall outcome of the
- * operation. In particular, whether or not it succeeded which is
- * indicated using a value of {@link ResultCode#SUCCESS}.
- * <li>The optional <b>diagnostic message</b> can be retrieved using the
- * method {@link #getDiagnosticMessage}. At the server's discretion, a
- * diagnostic message may be included in a Result in order to supplement
- * the result code with additional human-readable information.
+ * {@link #getResultCode}. This indicates the overall outcome of the operation.
+ * In particular, whether or not it succeeded which is indicated using a value
+ * of {@link ResultCode#SUCCESS}.
+ * <li>The optional <b>diagnostic message</b> can be retrieved using the method
+ * {@link #getDiagnosticMessage}. At the server's discretion, a diagnostic
+ * message may be included in a Result in order to supplement the result code
+ * with additional human-readable information.
* <li>The optional <b>matched DN</b> can be retrieved using the method
- * {@link #getMatchedDN}. For certain result codes, this is used to
- * indicate to the client the last entry used in finding the Request's
- * target (or base) entry.
+ * {@link #getMatchedDN}. For certain result codes, this is used to indicate to
+ * the client the last entry used in finding the Request's target (or base)
+ * entry.
* <li>The optional <b>referrals</b> can be retrieved using the method
- * {@link #getReferralURIs}. Referrals are present in a Result if the
- * result code is set to {@link ResultCode#REFERRAL}, and it are absent
- * with all other result codes.
+ * {@link #getReferralURIs}. Referrals are present in a Result if the result
+ * code is set to {@link ResultCode#REFERRAL}, and it are absent with all other
+ * result codes.
* </ul>
*/
public interface Result extends Response
@@ -61,14 +66,14 @@
/**
* {@inheritDoc}
*/
- Result addControl(Control control)
- throws UnsupportedOperationException, NullPointerException;
+ Result addControl(Control control) throws UnsupportedOperationException,
+ NullPointerException;
/**
* Adds the provided referral URI to this result.
- *
+ *
* @param uri
* The referral URI to be added.
* @return This result.
@@ -77,35 +82,16 @@
* @throws NullPointerException
* If {@code uri} was {@code null}.
*/
- Result addReferralURI(String uri)
- throws UnsupportedOperationException, NullPointerException;
+ Result addReferralURI(String uri) throws UnsupportedOperationException,
+ NullPointerException;
/**
- * {@inheritDoc}
- */
- Result clearControls() throws UnsupportedOperationException;
-
-
-
- /**
- * Removes all the referral URIs included with this result.
- *
- * @return This result.
- * @throws UnsupportedOperationException
- * If this result does not permit referral URIs to be
- * removed.
- */
- Result clearReferralURIs() throws UnsupportedOperationException;
-
-
-
- /**
- * Returns the throwable cause associated with this result if
- * available. A cause may be provided in cases where a result
- * indicates a failure due to a client-side error.
- *
+ * Returns the throwable cause associated with this result if available. A
+ * cause may be provided in cases where a result indicates a failure due to a
+ * client-side error.
+ *
* @return The throwable cause, or {@code null} if none was provided.
*/
Throwable getCause();
@@ -115,22 +101,23 @@
/**
* {@inheritDoc}
*/
- Control getControl(String oid) throws NullPointerException;
+ <C extends Control> C getControl(ControlDecoder<C> decoder,
+ DecodeOptions options) throws NullPointerException, DecodeException;
/**
* {@inheritDoc}
*/
- Iterable<Control> getControls();
+ List<Control> getControls();
/**
* Returns the diagnostic message associated with this result.
- *
- * @return The diagnostic message, which may be empty if none was
- * provided (never {@code null}).
+ *
+ * @return The diagnostic message, which may be empty if none was provided
+ * (never {@code null}).
*/
String getDiagnosticMessage();
@@ -138,28 +125,28 @@
/**
* Returns the matched DN associated with this result.
- *
- * @return The matched DN, which may be empty if none was provided
- * (never {@code null}).
+ *
+ * @return The matched DN, which may be empty if none was provided (never
+ * {@code null}).
*/
String getMatchedDN();
/**
- * Returns an {@code Iterable} containing the referral URIs included
- * with this result. The returned {@code Iterable} may be used to
- * remove referral URIs if permitted by this result.
- *
- * @return An {@code Iterable} containing the referral URIs.
+ * Returns a {@code List} containing the referral URIs included with this
+ * result. The returned {@code List} may be modified if permitted by this
+ * result.
+ *
+ * @return A {@code List} containing the referral URIs.
*/
- Iterable<String> getReferralURIs();
+ List<String> getReferralURIs();
/**
* Returns the result code associated with this result.
- *
+ *
* @return The result code.
*/
ResultCode getResultCode();
@@ -167,63 +154,37 @@
/**
- * {@inheritDoc}
- */
- boolean hasControls();
-
-
-
- /**
- * Indicates whether or not this result has any referral URIs.
- *
- * @return {@code true} if this result has any referral URIs,
- * otherwise {@code false}.
- */
- boolean hasReferralURIs();
-
-
-
- /**
- * Indicates whether or not a referral needs to be chased in order to
- * complete the operation.
+ * Indicates whether or not a referral needs to be chased in order to complete
+ * the operation.
* <p>
- * Specifically, this method returns {@code true} if the result code
- * is equal to {@link ResultCode#REFERRAL}.
- *
- * @return {@code true} if a referral needs to be chased, otherwise
- * {@code false}.
+ * Specifically, this method returns {@code true} if the result code is equal
+ * to {@link ResultCode#REFERRAL}.
+ *
+ * @return {@code true} if a referral needs to be chased, otherwise {@code
+ * false}.
*/
boolean isReferral();
/**
- * Indicates whether or not the request succeeded or not. This method
- * will return {code true} for all non-error responses.
- *
- * @return {@code true} if the request succeeded, otherwise {@code
- * false}.
+ * Indicates whether or not the request succeeded or not. This method will
+ * return {code true} for all non-error responses.
+ *
+ * @return {@code true} if the request succeeded, otherwise {@code false}.
*/
boolean isSuccess();
/**
- * {@inheritDoc}
- */
- Control removeControl(String oid)
- throws UnsupportedOperationException, NullPointerException;
-
-
-
- /**
- * Sets the throwable cause associated with this result if available.
- * A cause may be provided in cases where a result indicates a failure
- * due to a client-side error.
- *
+ * Sets the throwable cause associated with this result if available. A cause
+ * may be provided in cases where a result indicates a failure due to a
+ * client-side error.
+ *
* @param cause
- * The throwable cause, which may be {@code null} indicating
- * that none was provided.
+ * The throwable cause, which may be {@code null} indicating that
+ * none was provided.
* @return This result.
* @throws UnsupportedOperationException
* If this result does not permit the cause to be set.
@@ -234,14 +195,13 @@
/**
* Sets the diagnostic message associated with this result.
- *
+ *
* @param message
* The diagnostic message, which may be empty or {@code null}
* indicating that none was provided.
* @return This result.
* @throws UnsupportedOperationException
- * If this result does not permit the diagnostic message to
- * be set.
+ * If this result does not permit the diagnostic message to be set.
*/
Result setDiagnosticMessage(String message)
throws UnsupportedOperationException;
@@ -250,10 +210,10 @@
/**
* Sets the matched DN associated with this result.
- *
+ *
* @param dn
- * The matched DN associated, which may be empty or {@code
- * null} indicating that none was provided.
+ * The matched DN associated, which may be empty or {@code null}
+ * indicating that none was provided.
* @return This result.
* @throws UnsupportedOperationException
* If this result does not permit the matched DN to be set.
@@ -264,7 +224,7 @@
/**
* Sets the result code associated with this result.
- *
+ *
* @param resultCode
* The result code.
* @return This result.
--
Gitblit v1.10.0