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/24 20:57:35 UTC
svn commit: r606734 - in
/commons/proper/pool/branches/1_4_RELEASE_BRANCH/src/java/org/apache/commons/pool:
PoolUtils.java impl/CursorableLinkedList.java
impl/GenericKeyedObjectPool.java impl/GenericObjectPool.java
Author: psteitz
Date: Mon Dec 24 11:57:33 2007
New Revision: 606734
URL: http://svn.apache.org/viewvc?rev=606734&view=rev
Log:
Javadoc only.
Disambiguated some javadoc link references.
JIRA: POOL-114
Reported and patched by Sebastian Bazley
Modified:
commons/proper/pool/branches/1_4_RELEASE_BRANCH/src/java/org/apache/commons/pool/PoolUtils.java
commons/proper/pool/branches/1_4_RELEASE_BRANCH/src/java/org/apache/commons/pool/impl/CursorableLinkedList.java
commons/proper/pool/branches/1_4_RELEASE_BRANCH/src/java/org/apache/commons/pool/impl/GenericKeyedObjectPool.java
commons/proper/pool/branches/1_4_RELEASE_BRANCH/src/java/org/apache/commons/pool/impl/GenericObjectPool.java
Modified: commons/proper/pool/branches/1_4_RELEASE_BRANCH/src/java/org/apache/commons/pool/PoolUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/branches/1_4_RELEASE_BRANCH/src/java/org/apache/commons/pool/PoolUtils.java?rev=606734&r1=606733&r2=606734&view=diff
==============================================================================
--- commons/proper/pool/branches/1_4_RELEASE_BRANCH/src/java/org/apache/commons/pool/PoolUtils.java (original)
+++ commons/proper/pool/branches/1_4_RELEASE_BRANCH/src/java/org/apache/commons/pool/PoolUtils.java Mon Dec 24 11:57:33 2007
@@ -337,7 +337,7 @@
* <p><b>Note:</b>
* This should not be used on pool implementations that already provide proper synchronization
* such as the pools provided in the Commons Pool library. Wrapping a pool that
- * {@link #wait waits} for poolable objects to be returned before allowing another one to be
+ * {@link #wait() waits} for poolable objects to be returned before allowing another one to be
* borrowed with another layer of synchronization will cause liveliness issues or a deadlock.
* </p>
*
@@ -368,7 +368,7 @@
* <p><b>Note:</b>
* This should not be used on pool implementations that already provide proper synchronization
* such as the pools provided in the Commons Pool library. Wrapping a pool that
- * {@link #wait waits} for poolable objects to be returned before allowing another one to be
+ * {@link #wait() waits} for poolable objects to be returned before allowing another one to be
* borrowed with another layer of synchronization will cause liveliness issues or a deadlock.
* </p>
*
Modified: commons/proper/pool/branches/1_4_RELEASE_BRANCH/src/java/org/apache/commons/pool/impl/CursorableLinkedList.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/branches/1_4_RELEASE_BRANCH/src/java/org/apache/commons/pool/impl/CursorableLinkedList.java?rev=606734&r1=606733&r2=606734&view=diff
==============================================================================
--- commons/proper/pool/branches/1_4_RELEASE_BRANCH/src/java/org/apache/commons/pool/impl/CursorableLinkedList.java (original)
+++ commons/proper/pool/branches/1_4_RELEASE_BRANCH/src/java/org/apache/commons/pool/impl/CursorableLinkedList.java Mon Dec 24 11:57:33 2007
@@ -276,7 +276,7 @@
* is no longer necessary.
*
* @see #cursor(int)
- * @see #listIterator
+ * @see #listIterator()
* @see CursorableLinkedList.Cursor
*/
public CursorableLinkedList.Cursor cursor() {
@@ -293,7 +293,7 @@
* is not bothered by concurrent modifications to the
* underlying list.
*
- * @see #cursor
+ * @see #cursor()
* @see #listIterator(int)
* @see CursorableLinkedList.Cursor
* @throws IndexOutOfBoundsException if the index is out of range (index
@@ -483,7 +483,7 @@
/**
* Returns a fail-fast ListIterator.
- * @see List#listIterator
+ * @see List#listIterator()
*/
public ListIterator listIterator() {
return listIterator(0);
@@ -646,7 +646,7 @@
/**
* Returns an array containing all of the elements in this list in proper
- * sequence. Obeys the general contract of the {@link Collection#toArray} method.
+ * sequence. Obeys the general contract of the {@link Collection#toArray()} method.
*
* @return an array containing all of the elements in this list in proper
* sequence.
@@ -664,7 +664,7 @@
* Returns an array containing all of the elements in this list in proper
* sequence; the runtime type of the returned array is that of the
* specified array. Obeys the general contract of the
- * {@link Collection#toArray} method.
+ * {@link Collection#toArray()} method.
*
* @param a the array into which the elements of this list are to
* be stored, if it is big enough; otherwise, a new array of the
Modified: commons/proper/pool/branches/1_4_RELEASE_BRANCH/src/java/org/apache/commons/pool/impl/GenericKeyedObjectPool.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/branches/1_4_RELEASE_BRANCH/src/java/org/apache/commons/pool/impl/GenericKeyedObjectPool.java?rev=606734&r1=606733&r2=606734&view=diff
==============================================================================
--- commons/proper/pool/branches/1_4_RELEASE_BRANCH/src/java/org/apache/commons/pool/impl/GenericKeyedObjectPool.java (original)
+++ commons/proper/pool/branches/1_4_RELEASE_BRANCH/src/java/org/apache/commons/pool/impl/GenericKeyedObjectPool.java Mon Dec 24 11:57:33 2007
@@ -87,7 +87,7 @@
* <li>
* When {@link #setWhenExhaustedAction whenExhaustedAction}
* is {@link #WHEN_EXHAUSTED_BLOCK}, {@link #borrowObject borrowObject} will block
- * (invoke {@link Object#wait wait} until a new or idle object is available.
+ * (invoke {@link Object#wait() wait} until a new or idle object is available.
* If a positive {@link #setMaxWait maxWait}
* value is supplied, the {@link #borrowObject borrowObject} will block for at
* most that many milliseconds, after which a {@link NoSuchElementException}
@@ -809,7 +809,7 @@
* Sets the number of objects to examine during each run of the
* idle object evictor thread (if any).
* <p>
- * When a negative value is supplied, <code>ceil({@link #getNumIdle})/abs({@link #getNumTestsPerEvictionRun})</code>
+ * When a negative value is supplied, <code>ceil({@link #getNumIdle()})/abs({@link #getNumTestsPerEvictionRun})</code>
* tests will be run. I.e., when the value is <code>-n</code>, roughly one <code>n</code>th of the
* idle objects will be tested per run.
*
Modified: commons/proper/pool/branches/1_4_RELEASE_BRANCH/src/java/org/apache/commons/pool/impl/GenericObjectPool.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/branches/1_4_RELEASE_BRANCH/src/java/org/apache/commons/pool/impl/GenericObjectPool.java?rev=606734&r1=606733&r2=606734&view=diff
==============================================================================
--- commons/proper/pool/branches/1_4_RELEASE_BRANCH/src/java/org/apache/commons/pool/impl/GenericObjectPool.java (original)
+++ commons/proper/pool/branches/1_4_RELEASE_BRANCH/src/java/org/apache/commons/pool/impl/GenericObjectPool.java Mon Dec 24 11:57:33 2007
@@ -67,7 +67,7 @@
* <li>
* When {@link #setWhenExhaustedAction <i>whenExhaustedAction</i>}
* is {@link #WHEN_EXHAUSTED_BLOCK}, {@link #borrowObject} will block
- * (invoke {@link Object#wait} until a new or idle object is available.
+ * (invoke {@link Object#wait()} until a new or idle object is available.
* If a positive {@link #setMaxWait <i>maxWait</i>}
* value is supplied, the {@link #borrowObject} will block for at
* most that many milliseconds, after which a {@link NoSuchElementException}