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/api/SubtreeSpecification.java | 19 +++++++++++--------
1 files changed, 11 insertions(+), 8 deletions(-)
diff --git a/opendj-sdk/opends/src/server/org/opends/server/api/SubtreeSpecification.java b/opendj-sdk/opends/src/server/org/opends/server/api/SubtreeSpecification.java
index cdd1884..d580dbe 100644
--- a/opendj-sdk/opends/src/server/org/opends/server/api/SubtreeSpecification.java
+++ b/opendj-sdk/opends/src/server/org/opends/server/api/SubtreeSpecification.java
@@ -35,6 +35,11 @@
/**
* Generic subtree specification interface.
*/
+@org.opends.server.types.PublicAPI(
+ stability=org.opends.server.types.StabilityLevel.VOLATILE,
+ mayInstantiate=false,
+ mayExtend=true,
+ mayInvoke=false)
public abstract class SubtreeSpecification
{
/**
@@ -51,11 +56,10 @@
* Determine if an entry is within the scope of the subtree
* specification.
*
- * @param entry
- * The entry.
- * @return Returns <code>true</code> if the entry is within the
- * scope of the subtree specification, or <code>false</code>
- * otherwise.
+ * @param entry The entry.
+ *
+ * @return {@code true} if the entry is within the scope of the
+ * subtree specification, or {@code false} if not.
*/
public abstract boolean isWithinScope(Entry entry);
@@ -90,9 +94,8 @@
* Append the string representation of the subtree specification to
* the provided string builder.
*
- * @param builder
- * The string builder.
- * @return The string builder.
+ * @param builder The string builder.
+ * @return The string builder.
*/
public abstract StringBuilder toString(StringBuilder builder);
--
Gitblit v1.10.0