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/util/BuildVersion.java |   19 +++++++++++++++++--
 1 files changed, 17 insertions(+), 2 deletions(-)

diff --git a/opendj-sdk/opends/src/server/org/opends/server/util/BuildVersion.java b/opendj-sdk/opends/src/server/org/opends/server/util/BuildVersion.java
index 2c7507a..f1554ba 100644
--- a/opendj-sdk/opends/src/server/org/opends/server/util/BuildVersion.java
+++ b/opendj-sdk/opends/src/server/org/opends/server/util/BuildVersion.java
@@ -31,7 +31,12 @@
  * Represents a particular version of OpenDS useful for making
  * comparisons between versions.
  */
-public class BuildVersion implements Comparable<BuildVersion> {
+@org.opends.server.types.PublicAPI(
+     stability=org.opends.server.types.StabilityLevel.VOLATILE,
+     mayInstantiate=false,
+     mayExtend=false,
+     mayInvoke=true)
+public final class BuildVersion implements Comparable<BuildVersion> {
 
   /** Major release number. */
   int major;
@@ -105,7 +110,17 @@
   }
 
   /**
-   * {@inheritDoc}
+   * Retrieves an integer value that indicates the relative order between this
+   * build version and the provided build version object.
+   *
+   * @param  version  The build version object for which to make the
+   *                  determination.
+   *
+   * @return  A negative integer if this build version should be ordered before
+   *          the provided build version in a sorted list, a positive integer if
+   *          this build version should be ordered after the provided build
+   *          version in a sorted list, or zero if there is no difference in the
+   *          relative order between the build version objects.
    */
   public int compareTo(BuildVersion version) {
     if (major == version.major) {

--
Gitblit v1.10.0