You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ps...@apache.org on 2007/12/14 03:00:42 UTC
svn commit: r604085 -
/commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericObjectPool.java
Author: psteitz
Date: Thu Dec 13 18:00:35 2007
New Revision: 604085
URL: http://svn.apache.org/viewvc?rev=604085&view=rev
Log:
Javadoc fixes.
Modified:
commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericObjectPool.java
Modified: commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericObjectPool.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericObjectPool.java?rev=604085&r1=604084&r2=604085&view=diff
==============================================================================
--- commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericObjectPool.java (original)
+++ commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericObjectPool.java Thu Dec 13 18:00:35 2007
@@ -122,6 +122,19 @@
* </li>
* </ul>
* <p>
+ * <p>
+ * The pool can be configured to behave as a LIFO queue with respect to idle
+ * objects - always returning the most recently used object from the pool,
+ * or as a FIFO queue, where borrowObject always returns the oldest object
+ * in the idle object pool.
+ * <ul>
+ * <li>
+ * {@link #setLifo <i>Lifo</i>}
+ * determines whether or not the pool returns idle objects in
+ * last-in-first-out order.
+ * </li>
+ * </ul>
+ * <p>
* GenericObjectPool is not usable without a {@link PoolableObjectFactory}. A
* non-<code>null</code> factory must be provided either as a constructor argument
* or via a call to {@link #setFactory} before the pool is used.
@@ -210,6 +223,7 @@
* queue - objects are taken from the idle object pool in the order that
* they are returned to the pool.
* @see #setLifo
+ * @since 1.4
*/
public static final boolean DEFAULT_LIFO = true;
@@ -791,6 +805,8 @@
* in the pool (if there are idle instances available). False means that
* the pool behaves as a FIFO queue - objects are taken from the idle object
* pool in the order that they are returned to the pool.
+ *
+ * @since 1.4
*/
public synchronized boolean getLifo() {
return _lifo;
@@ -802,6 +818,9 @@
* idle instances available). False means that the pool behaves as a FIFO
* queue - objects are taken from the idle object pool in the order that
* they are returned to the pool.
+ *
+ * @param lifo the new value for the LIFO property
+ * @since 1.4
*/
public synchronized void setLifo(boolean lifo) {
this._lifo = lifo;
Re: svn commit: r604085 - /commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericObjectPool.java
Posted by sebb <se...@gmail.com>.
On 15/12/2007, Phil Steitz <ph...@gmail.com> wrote:
> On Dec 14, 2007 7:07 AM, sebb <se...@gmail.com> wrote:
> >
> > On 14/12/2007, psteitz@apache.org <ps...@apache.org> wrote:
> > > Author: psteitz
> > > Date: Thu Dec 13 18:00:35 2007
> > > New Revision: 604085
> > >
> > > URL: http://svn.apache.org/viewvc?rev=604085&view=rev
> > > Log:
> > > Javadoc fixes.
> > >
> > > Modified:
> > > commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericObjectPool.java
> > >
> > > Modified: commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericObjectPool.java
> > > URL: http://svn.apache.org/viewvc/commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericObjectPool.java?rev=604085&r1=604084&r2=604085&view=diff
> > > ==============================================================================
> > > --- commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericObjectPool.java (original)
> > > +++ commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericObjectPool.java Thu Dec 13 18:00:35 2007
> > > @@ -122,6 +122,19 @@
> > > * </li>
> > > * </ul>
> > > * <p>
> > > + * <p>
> > > + * The pool can be configured to behave as a LIFO queue with respect to idle
> > > + * objects - always returning the most recently used object from the pool,
> > > + * or as a FIFO queue, where borrowObject always returns the oldest object
> > > + * in the idle object pool.
> > > + * <ul>
> > > + * <li>
> > > + * {@link #setLifo <i>Lifo</i>}
> >
> > That should probably be #setLifo(boolean) ?
>
> Hmm. Here and elselwere I was following the style of the the
> surrounding code. The javadoc tool fills in the missing argument,
> since it is unambiguous in this case.
Sorry, you're right.
I was extrapolating from other #method links - such as {@link
Object#wait} at line 67 which is ambiguous - and assumed (without
checking) that all unqualified names should be qualified. My bad.
> Phil
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org
Re: svn commit: r604085 - /commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericObjectPool.java
Posted by Phil Steitz <ph...@gmail.com>.
On Dec 14, 2007 7:07 AM, sebb <se...@gmail.com> wrote:
>
> On 14/12/2007, psteitz@apache.org <ps...@apache.org> wrote:
> > Author: psteitz
> > Date: Thu Dec 13 18:00:35 2007
> > New Revision: 604085
> >
> > URL: http://svn.apache.org/viewvc?rev=604085&view=rev
> > Log:
> > Javadoc fixes.
> >
> > Modified:
> > commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericObjectPool.java
> >
> > Modified: commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericObjectPool.java
> > URL: http://svn.apache.org/viewvc/commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericObjectPool.java?rev=604085&r1=604084&r2=604085&view=diff
> > ==============================================================================
> > --- commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericObjectPool.java (original)
> > +++ commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericObjectPool.java Thu Dec 13 18:00:35 2007
> > @@ -122,6 +122,19 @@
> > * </li>
> > * </ul>
> > * <p>
> > + * <p>
> > + * The pool can be configured to behave as a LIFO queue with respect to idle
> > + * objects - always returning the most recently used object from the pool,
> > + * or as a FIFO queue, where borrowObject always returns the oldest object
> > + * in the idle object pool.
> > + * <ul>
> > + * <li>
> > + * {@link #setLifo <i>Lifo</i>}
>
> That should probably be #setLifo(boolean) ?
Hmm. Here and elselwere I was following the style of the the
surrounding code. The javadoc tool fills in the missing argument,
since it is unambiguous in this case.
Phil
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org
Re: svn commit: r604085 - /commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericObjectPool.java
Posted by sebb <se...@gmail.com>.
On 14/12/2007, psteitz@apache.org <ps...@apache.org> wrote:
> Author: psteitz
> Date: Thu Dec 13 18:00:35 2007
> New Revision: 604085
>
> URL: http://svn.apache.org/viewvc?rev=604085&view=rev
> Log:
> Javadoc fixes.
>
> Modified:
> commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericObjectPool.java
>
> Modified: commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericObjectPool.java
> URL: http://svn.apache.org/viewvc/commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericObjectPool.java?rev=604085&r1=604084&r2=604085&view=diff
> ==============================================================================
> --- commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericObjectPool.java (original)
> +++ commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericObjectPool.java Thu Dec 13 18:00:35 2007
> @@ -122,6 +122,19 @@
> * </li>
> * </ul>
> * <p>
> + * <p>
> + * The pool can be configured to behave as a LIFO queue with respect to idle
> + * objects - always returning the most recently used object from the pool,
> + * or as a FIFO queue, where borrowObject always returns the oldest object
> + * in the idle object pool.
> + * <ul>
> + * <li>
> + * {@link #setLifo <i>Lifo</i>}
That should probably be #setLifo(boolean) ?
> + * determines whether or not the pool returns idle objects in
> + * last-in-first-out order.
> + * </li>
> + * </ul>
> + * <p>
> * GenericObjectPool is not usable without a {@link PoolableObjectFactory}. A
> * non-<code>null</code> factory must be provided either as a constructor argument
> * or via a call to {@link #setFactory} before the pool is used.
> @@ -210,6 +223,7 @@
> * queue - objects are taken from the idle object pool in the order that
> * they are returned to the pool.
> * @see #setLifo
> + * @since 1.4
> */
> public static final boolean DEFAULT_LIFO = true;
>
> @@ -791,6 +805,8 @@
> * in the pool (if there are idle instances available). False means that
> * the pool behaves as a FIFO queue - objects are taken from the idle object
> * pool in the order that they are returned to the pool.
> + *
> + * @since 1.4
> */
> public synchronized boolean getLifo() {
> return _lifo;
> @@ -802,6 +818,9 @@
> * idle instances available). False means that the pool behaves as a FIFO
> * queue - objects are taken from the idle object pool in the order that
> * they are returned to the pool.
> + *
> + * @param lifo the new value for the LIFO property
> + * @since 1.4
> */
> public synchronized void setLifo(boolean lifo) {
> this._lifo = lifo;
>
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org
Re: svn commit: r604085 - /commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericObjectPool.java
Posted by sebb <se...@gmail.com>.
On 14/12/2007, psteitz@apache.org <ps...@apache.org> wrote:
> Author: psteitz
> Date: Thu Dec 13 18:00:35 2007
> New Revision: 604085
>
> URL: http://svn.apache.org/viewvc?rev=604085&view=rev
> Log:
> Javadoc fixes.
>
> Modified:
> commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericObjectPool.java
>
> Modified: commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericObjectPool.java
> URL: http://svn.apache.org/viewvc/commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericObjectPool.java?rev=604085&r1=604084&r2=604085&view=diff
> ==============================================================================
> --- commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericObjectPool.java (original)
> +++ commons/proper/pool/trunk/src/java/org/apache/commons/pool/impl/GenericObjectPool.java Thu Dec 13 18:00:35 2007
> @@ -122,6 +122,19 @@
> * </li>
> * </ul>
> * <p>
> + * <p>
> + * The pool can be configured to behave as a LIFO queue with respect to idle
> + * objects - always returning the most recently used object from the pool,
> + * or as a FIFO queue, where borrowObject always returns the oldest object
> + * in the idle object pool.
> + * <ul>
> + * <li>
> + * {@link #setLifo <i>Lifo</i>}
That should probably be #setLifo(boolean) ?
> + * determines whether or not the pool returns idle objects in
> + * last-in-first-out order.
> + * </li>
> + * </ul>
> + * <p>
> * GenericObjectPool is not usable without a {@link PoolableObjectFactory}. A
> * non-<code>null</code> factory must be provided either as a constructor argument
> * or via a call to {@link #setFactory} before the pool is used.
> @@ -210,6 +223,7 @@
> * queue - objects are taken from the idle object pool in the order that
> * they are returned to the pool.
> * @see #setLifo
> + * @since 1.4
> */
> public static final boolean DEFAULT_LIFO = true;
>
> @@ -791,6 +805,8 @@
> * in the pool (if there are idle instances available). False means that
> * the pool behaves as a FIFO queue - objects are taken from the idle object
> * pool in the order that they are returned to the pool.
> + *
> + * @since 1.4
> */
> public synchronized boolean getLifo() {
> return _lifo;
> @@ -802,6 +818,9 @@
> * idle instances available). False means that the pool behaves as a FIFO
> * queue - objects are taken from the idle object pool in the order that
> * they are returned to the pool.
> + *
> + * @param lifo the new value for the LIFO property
> + * @since 1.4
> */
> public synchronized void setLifo(boolean lifo) {
> this._lifo = lifo;
>
>
>