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/ApproximateMatchingRule.java | 19 ++++++++++++-------
1 files changed, 12 insertions(+), 7 deletions(-)
diff --git a/opendj-sdk/opends/src/server/org/opends/server/api/ApproximateMatchingRule.java b/opendj-sdk/opends/src/server/org/opends/server/api/ApproximateMatchingRule.java
index 713c3f1..f846970 100644
--- a/opendj-sdk/opends/src/server/org/opends/server/api/ApproximateMatchingRule.java
+++ b/opendj-sdk/opends/src/server/org/opends/server/api/ApproximateMatchingRule.java
@@ -39,6 +39,11 @@
* implemented by a Directory Server module that implements a matching
* rule used for approximate matching.
*/
+@org.opends.server.types.PublicAPI(
+ stability=org.opends.server.types.StabilityLevel.VOLATILE,
+ mayInstantiate=false,
+ mayExtend=true,
+ mayInvoke=false)
public abstract class ApproximateMatchingRule
extends MatchingRule<ApproximateMatchingRuleCfg>
{
@@ -51,8 +56,8 @@
* @param value2 The normalized form of the second value to
* compare.
*
- * @return <CODE>true</CODE> if the provided values are
- * approximately equal, or <CODE>false</CODE> if not.
+ * @return {@code true} if the provided values are approximately
+ * equal, or {@code false} if not.
*/
public abstract boolean approximatelyMatch(ByteString value1,
ByteString value2);
@@ -64,7 +69,7 @@
* considered a match for the given assertion value. This will only
* be used for the purpose of extensible matching. Other forms of
* matching against approximate matching rules should use the
- * <CODE>areEqual</CODE> method.
+ * {@code areEqual} method.
*
* @param attributeValue The attribute value in a form that has
* been normalized according to this
@@ -73,10 +78,10 @@
* been normalized according to this
* matching rule.
*
- * @return <CODE>TRUE</CODE> if the attribute value should be
- * considered a match for the provided assertion value,
- * <CODE>FALSE</CODE> if it does not match, or
- * <CODE>UNDEFINED</CODE> if the result is undefined.
+ * @return {@code TRUE} if the attribute value should be considered
+ * a match for the provided assertion value, {@code FALSE}
+ * if it does not match, or {@code UNDEFINED} if the result
+ * is undefined.
*/
public ConditionResult valuesMatch(ByteString attributeValue,
ByteString assertionValue)
--
Gitblit v1.10.0