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/MonitorProvider.java | 26 +++++++++++++++-----------
1 files changed, 15 insertions(+), 11 deletions(-)
diff --git a/opendj-sdk/opends/src/server/org/opends/server/api/MonitorProvider.java b/opendj-sdk/opends/src/server/org/opends/server/api/MonitorProvider.java
index 78812a0..e32a727 100644
--- a/opendj-sdk/opends/src/server/org/opends/server/api/MonitorProvider.java
+++ b/opendj-sdk/opends/src/server/org/opends/server/api/MonitorProvider.java
@@ -54,6 +54,11 @@
* @param <T> The type of configuration handled by this monitor
* provider.
*/
+@org.opends.server.types.PublicAPI(
+ stability=org.opends.server.types.StabilityLevel.VOLATILE,
+ mayInstantiate=false,
+ mayExtend=true,
+ mayInvoke=false)
public abstract class MonitorProvider<T extends MonitorProviderCfg>
extends DirectoryThread
{
@@ -73,7 +78,7 @@
/**
* Initializes this monitor provider. Note that no initialization
* should be done here, since it should be performed in the
- * <CODE>initializeMonitorProvider</CODE> class.
+ * {@code initializeMonitorProvider} class.
*
* @param threadName The name to use for this thread for debugging
* purposes.
@@ -148,7 +153,7 @@
* monitor provider that has resources that should be released when
* the monitor is no longer needed. Any monitor that does override
* this method must first invoke this version by calling
- * <CODE>super.finalizeMonitorProvider()</CODE>.
+ * {@code super.finalizeMonitorProvider}.
*/
public void finalizeMonitorProvider()
{
@@ -205,14 +210,13 @@
/**
* Retrieves the length of time in milliseconds that should elapse
- * between calls to the <CODE>updateMonitorData()</CODE> method. A
+ * between calls to the {@code updateMonitorData} method. A
* negative or zero return value indicates that the
- * <CODE>updateMonitorData()</CODE> method should not be
- * periodically invoked.
+ * {@code updateMonitorData} method should not be periodically
+ * invoked.
*
* @return The length of time in milliseconds that should elapse
- * between calls to the <CODE>updateMonitorData()</CODE>
- * method.
+ * between calls to the {@code updateMonitorData()} method.
*/
public abstract long getUpdateInterval();
@@ -222,8 +226,8 @@
* Performs any processing periodic processing that may be desired
* to update the information associated with this monitor. Note
* that best-effort attempts will be made to ensure that calls to
- * this method come <CODE>getUpdateInterval()</CODE> milliseconds
- * apart, but no guarantees will be made.
+ * this method come {@code getUpdateInterval} milliseconds apart,
+ * but no guarantees will be made.
*/
public abstract void updateMonitorData();
@@ -244,8 +248,8 @@
/**
* Enters a loop, periodically invoking the
- * <CODE>getUpdateInterval()</CODE> method to updates the data
- * associated with this monitor.
+ * {@code getUpdateInterval} method to updates the data associated
+ * with this monitor.
*/
public final void run()
{
--
Gitblit v1.10.0