Author: manik.surtani(a)jboss.com
Date: 2008-09-22 09:58:55 -0400 (Mon, 22 Sep 2008)
New Revision: 6768
Modified:
core/trunk/src/main/java/org/jboss/cache/Region.java
Log:
Better javadocs for deprecated methods
Modified: core/trunk/src/main/java/org/jboss/cache/Region.java
===================================================================
--- core/trunk/src/main/java/org/jboss/cache/Region.java 2008-09-22 13:08:45 UTC (rev
6767)
+++ core/trunk/src/main/java/org/jboss/cache/Region.java 2008-09-22 13:58:55 UTC (rev
6768)
@@ -216,6 +216,11 @@
/**
* Configures an eviction policy for this region.
+ * <p/>
+ * <b>Note:</b> This is deprecated since this is an internal method and
never was
+ * meant to be a part of the public API. Please do not treat this as public API, it
may be removed in a future release
+ * and its functionality is not guaranteed.
+ * <p/>
*
* @param evictionPolicyConfig configuration to set
* @deprecated
@@ -226,6 +231,11 @@
/**
* Returns an eviction policy configuration.
+ * <p/>
+ * <b>Note:</b> This is deprecated since this is an internal method and
never was
+ * meant to be a part of the public API. Please do not treat this as public API, it
may be removed in a future release
+ * and its functionality is not guaranteed.
+ * <p/>
*
* @return an eviction policy configuration
* @deprecated
@@ -236,6 +246,11 @@
/**
* Returns an eviction policy.
+ * <p/>
+ * <b>Note:</b> This is deprecated since this is an internal method and
never was
+ * meant to be a part of the public API. Please do not treat this as public API, it
may be removed in a future release
+ * and its functionality is not guaranteed.
+ * <p/>
*
* @return an eviction policy
* @deprecated
@@ -246,6 +261,11 @@
/**
* Returns the size of the node event queue, used by the eviction thread.
+ * <p/>
+ * <b>Note:</b> This is deprecated since this is an internal method and
never was
+ * meant to be a part of the public API. Please do not treat this as public API, it
may be removed in a future release
+ * and its functionality is not guaranteed.
+ * <p/>
*
* @return number of events
* @deprecated
@@ -257,6 +277,11 @@
/**
* Returns the most recent {@link org.jboss.cache.eviction.EvictedEventNode} added to
the event queue by
* {@link #putNodeEvent(org.jboss.cache.eviction.EvictedEventNode)}.
+ * <p/>
+ * <b>Note:</b> This is deprecated since this is an internal method and
never was
+ * meant to be a part of the public API. Please do not treat this as public API, it
may be removed in a future release
+ * and its functionality is not guaranteed.
+ * <p/>
*
* @return the last {@link org.jboss.cache.eviction.EvictedEventNode}, or null if no
more events exist
* @deprecated
@@ -268,6 +293,11 @@
/**
* Adds an {@link org.jboss.cache.eviction.EvictedEventNode} to the internal queue for
processing
* by the eviction thread.
+ * <p/>
+ * <b>Note:</b> This is deprecated since this is an internal method and
never was
+ * meant to be a part of the public API. Please do not treat this as public API, it
may be removed in a future release
+ * and its functionality is not guaranteed.
+ * <p/>
*
* @param event event to add
* @deprecated