Author: sandymac
Date: Wed Mar 29 09:23:00 2006
New Revision: 389839
URL: http://svn.apache.org/viewcvs?rev=389839&view=rev
Log:
Updated composite enum's javadocs to hopefully be clearer.
Tested to make sure when the enums are converted to Java 1.5 enums
in pool 3 that code compiled against pool 2 will continue to work fine.
Modified:
jakarta/commons/proper/pool/trunk/src/java/org/apache/commons/pool/composite/BorrowPolicy.java
jakarta/commons/proper/pool/trunk/src/java/org/apache/commons/pool/composite/ExhaustionPolicy.java
jakarta/commons/proper/pool/trunk/src/java/org/apache/commons/pool/composite/LimitPolicy.java
jakarta/commons/proper/pool/trunk/src/java/org/apache/commons/pool/composite/TrackingPolicy.java
Modified:
jakarta/commons/proper/pool/trunk/src/java/org/apache/commons/pool/composite/BorrowPolicy.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/pool/trunk/src/java/org/apache/commons/pool/composite/BorrowPolicy.java?rev=389839&r1=389838&r2=389839&view=diff
==============================================================================
---
jakarta/commons/proper/pool/trunk/src/java/org/apache/commons/pool/composite/BorrowPolicy.java
(original)
+++
jakarta/commons/proper/pool/trunk/src/java/org/apache/commons/pool/composite/BorrowPolicy.java
Wed Mar 29 09:23:00 2006
@@ -23,7 +23,7 @@
import java.lang.ref.SoftReference;
/**
- * Specifies the order in which objects are borrowed and returned to the pool.
+ * Configures how objects are borrowed and returned to the pool.
*
* @see CompositeObjectPoolFactory#setBorrowPolicy(BorrowPolicy)
* @see CompositeKeyedObjectPoolFactory#setBorrowPolicy(BorrowPolicy)
@@ -31,6 +31,7 @@
* @since #.#
* @version $Revision$ $Date$
*/
+/* XXX For Pool 3: public enum BorrowPolicy {FIFO, LIFO, SOFT_FIFO, SOFT_LIFO,
NULL} but keep existing Javadoc. */
public final class BorrowPolicy implements Serializable {
private static final long serialVersionUID = 3357921765798594792L;
Modified:
jakarta/commons/proper/pool/trunk/src/java/org/apache/commons/pool/composite/ExhaustionPolicy.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/pool/trunk/src/java/org/apache/commons/pool/composite/ExhaustionPolicy.java?rev=389839&r1=389838&r2=389839&view=diff
==============================================================================
---
jakarta/commons/proper/pool/trunk/src/java/org/apache/commons/pool/composite/ExhaustionPolicy.java
(original)
+++
jakarta/commons/proper/pool/trunk/src/java/org/apache/commons/pool/composite/ExhaustionPolicy.java
Wed Mar 29 09:23:00 2006
@@ -24,7 +24,7 @@
import java.util.NoSuchElementException;
/**
- * Specifies the behavior of the pool when the pool is out of idle objects.
+ * Configures the behavior of the pool when the pool is out of idle objects.
*
* @see CompositeObjectPoolFactory#setExhaustionPolicy(ExhaustionPolicy)
* @see CompositeKeyedObjectPoolFactory#setExhaustionPolicy(ExhaustionPolicy)
@@ -32,6 +32,7 @@
* @since #.#
* @version $Revision$ $Date$
*/
+/* XXX For Pool 3: public enum ExhaustionPolicy {GROW, FAIL} but keep existing
Javadoc. */
public final class ExhaustionPolicy implements Serializable {
private static final long serialVersionUID = -4895490364329810018L;
Modified:
jakarta/commons/proper/pool/trunk/src/java/org/apache/commons/pool/composite/LimitPolicy.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/pool/trunk/src/java/org/apache/commons/pool/composite/LimitPolicy.java?rev=389839&r1=389838&r2=389839&view=diff
==============================================================================
---
jakarta/commons/proper/pool/trunk/src/java/org/apache/commons/pool/composite/LimitPolicy.java
(original)
+++
jakarta/commons/proper/pool/trunk/src/java/org/apache/commons/pool/composite/LimitPolicy.java
Wed Mar 29 09:23:00 2006
@@ -24,7 +24,7 @@
import java.util.NoSuchElementException;
/**
- * Specifies the behavior of when the max number of active objects has been
reached.
+ * Configures the behavior of the pool when there is a limit on the number of
concurrently borrowed objects.
*
* @see CompositeObjectPoolFactory#setLimitPolicy(LimitPolicy)
* @see CompositeKeyedObjectPoolFactory#setLimitPolicy(LimitPolicy)
@@ -32,6 +32,7 @@
* @since #.#
* @version $Revision$ $Date$
*/
+/* XXX For Pool 3: public enum LimitPolicy {FAIL, WAIT} but keep existing
Javadoc. */
public final class LimitPolicy implements Serializable {
private static final long serialVersionUID = -4325661345028907604L;
Modified:
jakarta/commons/proper/pool/trunk/src/java/org/apache/commons/pool/composite/TrackingPolicy.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/pool/trunk/src/java/org/apache/commons/pool/composite/TrackingPolicy.java?rev=389839&r1=389838&r2=389839&view=diff
==============================================================================
---
jakarta/commons/proper/pool/trunk/src/java/org/apache/commons/pool/composite/TrackingPolicy.java
(original)
+++
jakarta/commons/proper/pool/trunk/src/java/org/apache/commons/pool/composite/TrackingPolicy.java
Wed Mar 29 09:23:00 2006
@@ -21,7 +21,7 @@
import java.lang.ref.WeakReference;
/**
- * Specifies how active objects are tracked while they are out of the pool.
+ * Configures how active objects are tracked while they are borrowed from the
pool.
*
* @see CompositeObjectPoolFactory#setTrackerType(TrackingPolicy)
* @see CompositeKeyedObjectPoolFactory#setTrackerType(TrackingPolicy)
@@ -29,6 +29,7 @@
* @since #.#
* @version $Revision$ $Date$
*/
+/* XXX For Pool 3: public enum TrackingPolicy {NULL, SIMPLE, REFERENCE, DEBUG}
but keep existing Javadoc. */
public final class TrackingPolicy implements Serializable {
private static final long serialVersionUID = 181851949909846032L;
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
