From 64afb3e53f74b2ec78cacb377858cb092e3a4e9b Mon Sep 17 00:00:00 2001
From: neil_a_wilson <neil_a_wilson@localhost>
Date: Thu, 16 Aug 2007 00:36:48 +0000
Subject: [PATCH] Update package-info.java files to include the @PublicAPI annotation to indicate whether any or all of the classes in that package are intended to be part of the public API. Further, mark all classes that we intend to be part of the public API with the @PublicAPI annotation to indicate the ways in which they may be used. Note that the use of these annotations and the ultimate determination as to what is in our public API and the ways in which those elements may be used still needs to be carefully reviewed before the 1.0 release.
---
opendj-sdk/opends/src/server/org/opends/server/protocols/internal/InternalSearchOperation.java | 67 +++++++++++++++++++++++++++++----
1 files changed, 58 insertions(+), 9 deletions(-)
diff --git a/opendj-sdk/opends/src/server/org/opends/server/protocols/internal/InternalSearchOperation.java b/opendj-sdk/opends/src/server/org/opends/server/protocols/internal/InternalSearchOperation.java
index 91010af..d6df5cb 100644
--- a/opendj-sdk/opends/src/server/org/opends/server/protocols/internal/InternalSearchOperation.java
+++ b/opendj-sdk/opends/src/server/org/opends/server/protocols/internal/InternalSearchOperation.java
@@ -54,7 +54,12 @@
* and references will be queued in memory rather than sent to a
* client since there is no real client.
*/
-public class InternalSearchOperation
+@org.opends.server.types.PublicAPI(
+ stability=org.opends.server.types.StabilityLevel.UNCOMMITTED,
+ mayInstantiate=true,
+ mayExtend=false,
+ mayInvoke=true)
+public final class InternalSearchOperation
extends SearchOperationBasis
{
// The internal search listener for this search, if one was
@@ -228,6 +233,11 @@
* the provided entry and the search
* should be terminated.
*/
+ @org.opends.server.types.PublicAPI(
+ stability=org.opends.server.types.StabilityLevel.PRIVATE,
+ mayInstantiate=false,
+ mayExtend=false,
+ mayInvoke=false)
public void addSearchEntry(SearchResultEntry searchEntry)
throws DirectoryException
{
@@ -270,6 +280,11 @@
* the provided reference and the
* search should be terminated.
*/
+ @org.opends.server.types.PublicAPI(
+ stability=org.opends.server.types.StabilityLevel.PRIVATE,
+ mayInstantiate=false,
+ mayExtend=false,
+ mayInvoke=false)
public void addSearchReference(
SearchResultReference searchReference)
throws DirectoryException
@@ -285,25 +300,59 @@
}
}
+
+
/**
- * {@inheritDoc}
+ * Sends the provided search result entry to the client.
+ *
+ * @param searchEntry The search result entry to be sent to the
+ * client.
+ *
+ * @throws DirectoryException If a problem occurs while attempting
+ * to send the entry to the client and
+ * the search should be terminated.
*/
+ @org.opends.server.types.PublicAPI(
+ stability=org.opends.server.types.StabilityLevel.PRIVATE,
+ mayInstantiate=false,
+ mayExtend=false,
+ mayInvoke=false)
+ @Override()
public void sendSearchEntry(SearchResultEntry searchEntry)
- throws DirectoryException
- {
+ throws DirectoryException
+ {
addSearchEntry(searchEntry);
}
+
+
/**
- * {@inheritDoc}
+ * Sends the provided search result reference to the client.
+ *
+ * @param searchReference The search result reference to be sent
+ * to the client.
+ *
+ * @return {@code true} if the client is able to accept referrals,
+ * or {@code false} if the client cannot handle referrals
+ * and no more attempts should be made to send them for the
+ * associated search operation.
+ *
+ * @throws DirectoryException If a problem occurs while attempting
+ * to send the reference to the client
+ * and the search should be terminated.
*/
- public boolean sendSearchReference(SearchResultReference
- searchReference)
- throws DirectoryException
+ @org.opends.server.types.PublicAPI(
+ stability=org.opends.server.types.StabilityLevel.PRIVATE,
+ mayInstantiate=false,
+ mayExtend=false,
+ mayInvoke=false)
+ @Override()
+ public boolean sendSearchReference(
+ SearchResultReference searchReference)
+ throws DirectoryException
{
addSearchReference(searchReference);
return true;
}
-
}
--
Gitblit v1.10.0