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/MatchingRule.java | 43 ++++++++++++++++++++++++-------------------
1 files changed, 24 insertions(+), 19 deletions(-)
diff --git a/opendj-sdk/opends/src/server/org/opends/server/api/MatchingRule.java b/opendj-sdk/opends/src/server/org/opends/server/api/MatchingRule.java
index cbe6002..cac5924 100644
--- a/opendj-sdk/opends/src/server/org/opends/server/api/MatchingRule.java
+++ b/opendj-sdk/opends/src/server/org/opends/server/api/MatchingRule.java
@@ -48,6 +48,11 @@
* @param <T> The type of configuration handled by this matching
* rule.
*/
+@org.opends.server.types.PublicAPI(
+ stability=org.opends.server.types.StabilityLevel.VOLATILE,
+ mayInstantiate=false,
+ mayExtend=true,
+ mayInvoke=false)
public abstract class MatchingRule<T extends MatchingRuleCfg>
{
/**
@@ -116,8 +121,8 @@
/**
* Retrieves the common name for this matching rule.
*
- * @return The common name for this matching rule, or
- * <CODE>null</CODE> if it does not have a name.
+ * @return The common name for this matching rule, or {@code null}
+ * if it does not have a name.
*/
public abstract String getName();
@@ -139,7 +144,7 @@
*
* @return The name or OID for this matching rule.
*/
- public String getNameOrOID()
+ public final String getNameOrOID()
{
String name = getName();
if ((name == null) || (name.length() == 0))
@@ -157,8 +162,8 @@
/**
* Retrieves the description for this matching rule.
*
- * @return The description for this matching rule, or
- * <CODE>null</CODE> if there is none.
+ * @return The description for this matching rule, or {@code null}
+ * if there is none.
*/
public abstract String getDescription();
@@ -177,13 +182,13 @@
/**
* Indicates whether this matching rule is declared "OBSOLETE".
- * The default implementation will always return <CODE>false</CODE>.
- * If that is not acceptable for a particular matching rule
+ * The default implementation will always return {@code false}. If
+ * that is not acceptable for a particular matching rule
* implementation, then it should override this method and perform
* the appropriate processing to return the correct value.
*
- * @return <CODE>true</CODE> if this matching rule is declared
- * "OBSOLETE", or <CODE>false</CODE> if not.
+ * @return {@code true} if this matching rule is declared
+ * "OBSOLETE", or {@code false} if not.
*/
public boolean isObsolete()
{
@@ -224,10 +229,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 abstract ConditionResult
valuesMatch(ByteString attributeValue,
@@ -241,7 +246,7 @@
*
* @return The hash code for this matching rule.
*/
- public int hashCode()
+ public final int hashCode()
{
int hashCode = 0;
@@ -264,10 +269,10 @@
*
* @param o The object for which to make the determination.
*
- * @return <CODE>true</CODE> if the provided object is equal to
- * this matching rule, or <CODE>false</CODE> if it is not.
+ * @return {@code true} if the provided object is equal to this
+ * matching rule, or {@code false} if it is not.
*/
- public boolean equals(Object o)
+ public final boolean equals(Object o)
{
if (o == null)
{
@@ -296,7 +301,7 @@
* @return A string representation of this matching rule in the
* format defined in RFC 2252.
*/
- public String toString()
+ public final String toString()
{
StringBuilder buffer = new StringBuilder();
toString(buffer);
@@ -312,7 +317,7 @@
* @param buffer The buffer to which the information should be
* appended.
*/
- public void toString(StringBuilder buffer)
+ public final void toString(StringBuilder buffer)
{
buffer.append("( ");
buffer.append(getOID());
--
Gitblit v1.10.0