This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-pool.git
The following commit(s) were added to refs/heads/master by this push:
new f9443a4 Javadoc: Use {@code} instead of <code></code>.
f9443a4 is described below
commit f9443a4cbe2395481802d88252d7f9e18b28dd99
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Wed Dec 11 18:36:51 2019 -0500
Javadoc: Use {@code} instead of <code></code>.
---
.../pool2/BaseKeyedPooledObjectFactory.java | 4 +-
.../org/apache/commons/pool2/BaseObjectPool.java | 8 +-
.../commons/pool2/BasePooledObjectFactory.java | 2 +-
.../org/apache/commons/pool2/KeyedObjectPool.java | 42 ++++----
.../commons/pool2/KeyedPooledObjectFactory.java | 16 +--
.../java/org/apache/commons/pool2/ObjectPool.java | 8 +-
.../org/apache/commons/pool2/PooledObject.java | 4 +-
.../apache/commons/pool2/PooledObjectFactory.java | 12 +--
.../apache/commons/pool2/impl/AbandonedConfig.java | 6 +-
.../commons/pool2/impl/BaseGenericObjectPool.java | 120 ++++++++++-----------
.../commons/pool2/impl/BaseObjectPoolConfig.java | 6 +-
.../pool2/impl/DefaultPooledObjectInfoMBean.java | 6 +-
.../apache/commons/pool2/impl/EvictionPolicy.java | 4 +-
.../commons/pool2/impl/GenericKeyedObjectPool.java | 34 +++---
.../commons/pool2/impl/GenericObjectPool.java | 24 ++---
.../pool2/impl/SoftReferenceObjectPool.java | 16 +--
.../apache/commons/pool2/TestKeyedObjectPool.java | 2 +-
.../org/apache/commons/pool2/TestObjectPool.java | 2 +-
src/test/java/org/apache/commons/pool2/Waiter.java | 4 +-
.../pool2/impl/TestGenericKeyedObjectPool.java | 4 +-
20 files changed, 162 insertions(+), 162 deletions(-)
diff --git
a/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java
b/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java
index 2486170..0c7dfd0 100644
--- a/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java
+++ b/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java
@@ -17,7 +17,7 @@
package org.apache.commons.pool2;
/**
- * A base implementation of <code>KeyedPooledObjectFactory</code>.
+ * A base implementation of {@code KeyedPooledObjectFactory}.
* <p>
* All operations defined here are essentially no-op's.
* </p>
@@ -85,7 +85,7 @@ public abstract class BaseKeyedPooledObjectFactory<K, V>
extends BaseObject
*
* @param key the key used when selecting the object
* @param p a {@code PooledObject} wrapping the instance to be validated
- * @return always <code>true</code> in the default implementation
+ * @return always {@code true} in the default implementation
*/
@Override
public boolean validateObject(final K key, final PooledObject<V> p) {
diff --git a/src/main/java/org/apache/commons/pool2/BaseObjectPool.java
b/src/main/java/org/apache/commons/pool2/BaseObjectPool.java
index 331c43b..c20b1d7 100644
--- a/src/main/java/org/apache/commons/pool2/BaseObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/BaseObjectPool.java
@@ -85,8 +85,8 @@ public abstract class BaseObjectPool<T> extends BaseObject
implements ObjectPool
/**
* {@inheritDoc}
* <p>
- * This affects the behavior of <code>isClosed</code> and
- * <code>assertOpen</code>.
+ * This affects the behavior of {@code isClosed} and
+ * {@code assertOpen}.
* </p>
*/
@Override
@@ -97,14 +97,14 @@ public abstract class BaseObjectPool<T> extends BaseObject
implements ObjectPool
/**
* Has this pool instance been closed.
*
- * @return <code>true</code> when this pool has been closed.
+ * @return {@code true} when this pool has been closed.
*/
public final boolean isClosed() {
return closed;
}
/**
- * Throws an <code>IllegalStateException</code> when this pool has been
+ * Throws an {@code IllegalStateException} when this pool has been
* closed.
*
* @throws IllegalStateException when this pool has been closed.
diff --git
a/src/main/java/org/apache/commons/pool2/BasePooledObjectFactory.java
b/src/main/java/org/apache/commons/pool2/BasePooledObjectFactory.java
index 000632b..18338f6 100644
--- a/src/main/java/org/apache/commons/pool2/BasePooledObjectFactory.java
+++ b/src/main/java/org/apache/commons/pool2/BasePooledObjectFactory.java
@@ -17,7 +17,7 @@
package org.apache.commons.pool2;
/**
- * A base implementation of <code>PoolableObjectFactory</code>.
+ * A base implementation of {@code PoolableObjectFactory}.
* <p>
* All operations defined here are essentially no-op's.
* <p>
diff --git a/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
b/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
index ccf9f72..edf5ead 100644
--- a/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
@@ -72,7 +72,7 @@ public interface KeyedObjectPool<K, V> extends Closeable {
/**
* Create an object using the {@link KeyedPooledObjectFactory factory} or
* other implementation dependent mechanism, passivate it, and then place
it
- * in the idle object pool. <code>addObject</code> is useful for
+ * in the idle object pool. {@code addObject} is useful for
* "pre-loading" a pool with idle objects (Optional operation).
*
* @param key the key a new instance should be added to
@@ -89,19 +89,19 @@ public interface KeyedObjectPool<K, V> extends Closeable {
/**
* Calls {@link KeyedObjectPool#addObject(Object)} with each
- * key in <code>keys</code> for <code>count</code> number of times. This
has
+ * key in {@code keys} for {@code count} number of times. This has
* the same effect as calling {@link #addObjects(Object, int)}
- * for each key in the <code>keys</code> collection.
+ * for each key in the {@code keys} collection.
*
* @param keys
* {@link Collection} of keys to add objects for.
* @param count
- * the number of idle objects to add for each <code>key</code>.
+ * the number of idle objects to add for each {@code key}.
* @throws Exception
* when {@link KeyedObjectPool#addObject(Object)} fails.
* @throws IllegalArgumentException
- * when <code>keyedPool</code>, <code>keys</code>, or any value
- * in <code>keys</code> is <code>null</code>.
+ * when {@code keyedPool}, {@code keys}, or any value
+ * in {@code keys} is {@code null}.
* @see #addObjects(Object, int)
*/
default void addObjects(final Collection<K> keys, final int count) throws
Exception, IllegalArgumentException {
@@ -116,16 +116,16 @@ public interface KeyedObjectPool<K, V> extends Closeable {
/**
* Calls {@link KeyedObjectPool#addObject(Object)}
- * <code>key</code> <code>count</code> number of times.
+ * {@code key} {@code count} number of times.
*
* @param key
* the key to add objects for.
* @param count
- * the number of idle objects to add for <code>key</code>.
+ * the number of idle objects to add for {@code key}.
* @throws Exception
* when {@link KeyedObjectPool#addObject(Object)} fails.
* @throws IllegalArgumentException
- * when <code>key</code> is <code>null</code>.
+ * when {@code key} is {@code null}.
* @since 2.8.0
*/
default void addObjects(final K key, final int count) throws Exception,
IllegalArgumentException {
@@ -138,7 +138,7 @@ public interface KeyedObjectPool<K, V> extends Closeable {
}
/**
- * Obtains an instance from this pool for the specified <code>key</code>.
+ * Obtains an instance from this pool for the specified {@code key}.
* <p>
* Instances returned from this method will have been either newly created
* with {@link KeyedPooledObjectFactory#makeObject makeObject} or will be
@@ -151,7 +151,7 @@ public interface KeyedObjectPool<K, V> extends Closeable {
* By contract, clients <strong>must</strong> return the borrowed object
* using {@link #returnObject returnObject},
* {@link #invalidateObject invalidateObject}, or a related method as
- * defined in an implementation or sub-interface, using a <code>key</code>
+ * defined in an implementation or sub-interface, using a {@code key}
* that is {@link Object#equals equivalent} to the one used to borrow the
* instance in the first place.
* </p>
@@ -187,7 +187,7 @@ public interface KeyedObjectPool<K, V> extends Closeable {
/**
* Clears the specified pool, removing all pooled instances corresponding
to
- * the given <code>key</code> (optional operation).
+ * the given {@code key} (optional operation).
*
* @param key the key to clear
*
@@ -223,12 +223,12 @@ public interface KeyedObjectPool<K, V> extends Closeable {
/**
* Returns the number of instances currently borrowed from but not yet
- * returned to the pool corresponding to the given <code>key</code>.
+ * returned to the pool corresponding to the given {@code key}.
* Returns a negative value if this information is not available.
*
* @param key the key to query
* @return the number of instances currently borrowed from but not yet
- * returned to the pool corresponding to the given <code>key</code>.
+ * returned to the pool corresponding to the given {@code key}.
*/
int getNumActive(K key);
@@ -241,22 +241,22 @@ public interface KeyedObjectPool<K, V> extends Closeable {
/**
* Returns the number of instances corresponding to the given
- * <code>key</code> currently idle in this pool. Returns a negative value
if
+ * {@code key} currently idle in this pool. Returns a negative value if
* this information is not available.
*
* @param key the key to query
* @return the number of instances corresponding to the given
- * <code>key</code> currently idle in this pool.
+ * {@code key} currently idle in this pool.
*/
int getNumIdle(K key);
/**
* Invalidates an object from the pool.
* <p>
- * By contract, <code>obj</code> <strong>must</strong> have been obtained
+ * By contract, {@code obj} <strong>must</strong> have been obtained
* using {@link #borrowObject borrowObject} or a related method as defined
- * in an implementation or sub-interface using a <code>key</code> that is
- * equivalent to the one used to borrow the <code>Object</code> in the
first
+ * in an implementation or sub-interface using a {@code key} that is
+ * equivalent to the one used to borrow the {@code Object} in the first
* place.
* </p>
* <p>
@@ -272,10 +272,10 @@ public interface KeyedObjectPool<K, V> extends Closeable {
void invalidateObject(K key, V obj) throws Exception;
/**
- * Return an instance to the pool. By contract, <code>obj</code>
+ * Return an instance to the pool. By contract, {@code obj}
* <strong>must</strong> have been obtained using
* {@link #borrowObject borrowObject} or a related method as defined in an
- * implementation or sub-interface using a <code>key</code> that is
+ * implementation or sub-interface using a {@code key} that is
* equivalent to the one used to borrow the instance in the first place.
*
* @param key the key used to obtain the object
diff --git
a/src/main/java/org/apache/commons/pool2/KeyedPooledObjectFactory.java
b/src/main/java/org/apache/commons/pool2/KeyedPooledObjectFactory.java
index 6d0aa63..bb753cf 100644
--- a/src/main/java/org/apache/commons/pool2/KeyedPooledObjectFactory.java
+++ b/src/main/java/org/apache/commons/pool2/KeyedPooledObjectFactory.java
@@ -36,7 +36,7 @@ package org.apache.commons.pool2;
* {@link #validateObject} may be invoked on {@link #activateObject
activated}
* instances to make sure they can be
* {@link KeyedObjectPool#borrowObject borrowed} from the pool.
- * <code>validateObject</code> may also be used to test an
+ * {@code validateObject} may also be used to test an
* instance being {@link KeyedObjectPool#returnObject returned} to the pool
* before it is {@link #passivateObject passivated}. It will only be invoked
* on an activated instance.
@@ -48,7 +48,7 @@ package org.apache.commons.pool2;
* <li>
* {@link #destroyObject destroyObject}
* is invoked on every instance when it is being "dropped" from the
- * pool (whether due to the response from <code>validateObject</code>,
+ * pool (whether due to the response from {@code validateObject},
* or for reasons specific to the pool implementation.) There is no
* guarantee that the instance being destroyed will
* be considered active, passive or in a generally consistent state.
@@ -57,7 +57,7 @@ package org.apache.commons.pool2;
* {@link KeyedPooledObjectFactory} must be thread-safe. The only promise
* an {@link KeyedObjectPool} makes is that the same instance of an object will
* not be passed to more than one method of a
- * <code>KeyedPoolableObjectFactory</code> at a time.
+ * {@code KeyedPoolableObjectFactory} at a time.
* <p>
* While clients of a {@link KeyedObjectPool} borrow and return instances of
* the underlying value type V, the factory methods act on instances of
@@ -94,7 +94,7 @@ public interface KeyedPooledObjectFactory<K, V> {
* Destroy an instance no longer needed by the pool.
* <p>
* It is important for implementations of this method to be aware that
there
- * is no guarantee about what state <code>obj</code> will be in and the
+ * is no guarantee about what state {@code obj} will be in and the
* implementation should be prepared to handle unexpected errors.
* </p>
* <p>
@@ -119,8 +119,8 @@ public interface KeyedPooledObjectFactory<K, V> {
* @param key the key used when selecting the object
* @param p a {@code PooledObject} wrapping the instance to be validated
*
- * @return <code>false</code> if <code>obj</code> is not valid and should
- * be dropped from the pool, <code>true</code> otherwise.
+ * @return {@code false} if {@code obj} is not valid and should
+ * be dropped from the pool, {@code true} otherwise.
*/
boolean validateObject(K key, PooledObject<V> p);
@@ -130,7 +130,7 @@ public interface KeyedPooledObjectFactory<K, V> {
* @param key the key used when selecting the object
* @param p a {@code PooledObject} wrapping the instance to be activated
*
- * @throws Exception if there is a problem activating <code>obj</code>,
+ * @throws Exception if there is a problem activating {@code obj},
* this exception may be swallowed by the pool.
*
* @see #destroyObject
@@ -143,7 +143,7 @@ public interface KeyedPooledObjectFactory<K, V> {
* @param key the key used when selecting the object
* @param p a {@code PooledObject} wrapping the instance to be passivated
*
- * @throws Exception if there is a problem passivating <code>obj</code>,
+ * @throws Exception if there is a problem passivating {@code obj},
* this exception may be swallowed by the pool.
*
* @see #destroyObject
diff --git a/src/main/java/org/apache/commons/pool2/ObjectPool.java
b/src/main/java/org/apache/commons/pool2/ObjectPool.java
index 6b8086a..f8250af 100644
--- a/src/main/java/org/apache/commons/pool2/ObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/ObjectPool.java
@@ -62,7 +62,7 @@ public interface ObjectPool<T> extends Closeable {
/**
* Creates an object using the {@link PooledObjectFactory factory} or other
* implementation dependent mechanism, passivate it, and then place it in
- * the idle object pool. <code>addObject</code> is useful for "pre-loading"
+ * the idle object pool. {@code addObject} is useful for "pre-loading"
* a pool with idle objects. (Optional operation).
*
* @throws Exception
@@ -76,7 +76,7 @@ public interface ObjectPool<T> extends Closeable {
UnsupportedOperationException;
/**
- * Calls {@link ObjectPool#addObject()} <code>count</code>
+ * Calls {@link ObjectPool#addObject()} {@code count}
* number of times.
*
* @param count
@@ -169,7 +169,7 @@ public interface ObjectPool<T> extends Closeable {
/**
* Invalidates an object from the pool.
* <p>
- * By contract, <code>obj</code> <strong>must</strong> have been obtained
+ * By contract, {@code obj} <strong>must</strong> have been obtained
* using {@link #borrowObject} or a related method as defined in an
* implementation or sub-interface.
* </p>
@@ -185,7 +185,7 @@ public interface ObjectPool<T> extends Closeable {
void invalidateObject(T obj) throws Exception;
/**
- * Returns an instance to the pool. By contract, <code>obj</code>
+ * Returns an instance to the pool. By contract, {@code obj}
* <strong>must</strong> have been obtained using {@link #borrowObject()}
or
* a related method as defined in an implementation or sub-interface.
*
diff --git a/src/main/java/org/apache/commons/pool2/PooledObject.java
b/src/main/java/org/apache/commons/pool2/PooledObject.java
index d39b0a3..3ee8219 100644
--- a/src/main/java/org/apache/commons/pool2/PooledObject.java
+++ b/src/main/java/org/apache/commons/pool2/PooledObject.java
@@ -134,9 +134,9 @@ public interface PooledObject<T> extends
Comparable<PooledObject<T>> {
* Attempts to place the pooled object in the
* {@link PooledObjectState#EVICTION} state.
*
- * @return <code>true</code> if the object was placed in the
+ * @return {@code true} if the object was placed in the
* {@link PooledObjectState#EVICTION} state otherwise
- * <code>false</code>
+ * {@code false}
*/
boolean startEvictionTest();
diff --git a/src/main/java/org/apache/commons/pool2/PooledObjectFactory.java
b/src/main/java/org/apache/commons/pool2/PooledObjectFactory.java
index 65732da..cc7f794 100644
--- a/src/main/java/org/apache/commons/pool2/PooledObjectFactory.java
+++ b/src/main/java/org/apache/commons/pool2/PooledObjectFactory.java
@@ -54,7 +54,7 @@ package org.apache.commons.pool2;
* </ol>
* {@link PooledObjectFactory} must be thread-safe. The only promise
* an {@link ObjectPool} makes is that the same instance of an object will not
- * be passed to more than one method of a <code>PoolableObjectFactory</code>
+ * be passed to more than one method of a {@code PoolableObjectFactory}
* at a time.
* <p>
* While clients of a {@link KeyedObjectPool} borrow and return instances of
@@ -87,7 +87,7 @@ public interface PooledObjectFactory<T> {
* Destroys an instance no longer needed by the pool.
* <p>
* It is important for implementations of this method to be aware that there
- * is no guarantee about what state <code>obj</code> will be in and the
+ * is no guarantee about what state {@code obj} will be in and the
* implementation should be prepared to handle unexpected errors.
* </p>
* <p>
@@ -110,8 +110,8 @@ public interface PooledObjectFactory<T> {
*
* @param p a {@code PooledObject} wrapping the instance to be validated
*
- * @return <code>false</code> if <code>obj</code> is not valid and should
- * be dropped from the pool, <code>true</code> otherwise.
+ * @return {@code false} if {@code obj} is not valid and should
+ * be dropped from the pool, {@code true} otherwise.
*/
boolean validateObject(PooledObject<T> p);
@@ -120,7 +120,7 @@ public interface PooledObjectFactory<T> {
*
* @param p a {@code PooledObject} wrapping the instance to be activated
*
- * @throws Exception if there is a problem activating <code>obj</code>,
+ * @throws Exception if there is a problem activating {@code obj},
* this exception may be swallowed by the pool.
*
* @see #destroyObject
@@ -132,7 +132,7 @@ public interface PooledObjectFactory<T> {
*
* @param p a {@code PooledObject} wrapping the instance to be passivated
*
- * @throws Exception if there is a problem passivating <code>obj</code>,
+ * @throws Exception if there is a problem passivating {@code obj},
* this exception may be swallowed by the pool.
*
* @see #destroyObject
diff --git a/src/main/java/org/apache/commons/pool2/impl/AbandonedConfig.java
b/src/main/java/org/apache/commons/pool2/impl/AbandonedConfig.java
index 3f87d04..6466a4d 100644
--- a/src/main/java/org/apache/commons/pool2/impl/AbandonedConfig.java
+++ b/src/main/java/org/apache/commons/pool2/impl/AbandonedConfig.java
@@ -42,7 +42,7 @@ public class AbandonedConfig {
*
* <p>If set to true, abandoned objects are removed by borrowObject if
* there are fewer than 2 idle objects available in the pool and
- * <code>getNumActive() > getMaxTotal() - 3</code></p>
+ * {@code getNumActive() > getMaxTotal() - 3}</p>
*
* @return true if abandoned objects are to be removed by borrowObject
*/
@@ -245,7 +245,7 @@ public class AbandonedConfig {
* stack trace every time a method is called on a pooled object and retain
* the most recent stack trace to aid debugging of abandoned objects?
*
- * @return <code>true</code> if usage tracking is enabled
+ * @return {@code true} if usage tracking is enabled
*/
public boolean getUseUsageTracking() {
return useUsageTracking;
@@ -257,7 +257,7 @@ public class AbandonedConfig {
* object and retain the most recent stack trace to aid debugging of
* abandoned objects.
*
- * @param useUsageTracking A value of <code>true</code> will enable
+ * @param useUsageTracking A value of {@code true} will enable
* the recording of a stack trace on every use
* of a pooled object
*/
diff --git
a/src/main/java/org/apache/commons/pool2/impl/BaseGenericObjectPool.java
b/src/main/java/org/apache/commons/pool2/impl/BaseGenericObjectPool.java
index 17d2bd2..9ebdaee 100644
--- a/src/main/java/org/apache/commons/pool2/impl/BaseGenericObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/impl/BaseGenericObjectPool.java
@@ -189,11 +189,11 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject {
}
/**
- * Returns whether to block when the <code>borrowObject()</code> method is
+ * Returns whether to block when the {@code borrowObject()} method is
* invoked when the pool is exhausted (the maximum number of "active"
* objects has been reached).
*
- * @return <code>true</code> if <code>borrowObject()</code> should block
+ * @return {@code true} if {@code borrowObject()} should block
* when the pool is exhausted
*
* @see #setBlockWhenExhausted
@@ -203,12 +203,12 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject {
}
/**
- * Sets whether to block when the <code>borrowObject()</code> method is
+ * Sets whether to block when the {@code borrowObject()} method is
* invoked when the pool is exhausted (the maximum number of "active"
* objects has been reached).
*
- * @param blockWhenExhausted <code>true</code> if
- * <code>borrowObject()</code> should block
+ * @param blockWhenExhausted {@code true} if
+ * {@code borrowObject()} should block
* when the pool is exhausted
*
* @see #getBlockWhenExhausted
@@ -247,12 +247,12 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject {
/**
* Returns the maximum amount of time (in milliseconds) the
- * <code>borrowObject()</code> method should block before throwing an
+ * {@code borrowObject()} method should block before throwing an
* exception when the pool is exhausted and
* {@link #getBlockWhenExhausted} is true. When less than 0, the
- * <code>borrowObject()</code> method may block indefinitely.
+ * {@code borrowObject()} method may block indefinitely.
*
- * @return the maximum number of milliseconds <code>borrowObject()</code>
+ * @return the maximum number of milliseconds {@code borrowObject()}
* will block.
*
* @see #setMaxWaitMillis
@@ -264,13 +264,13 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject {
/**
* Sets the maximum amount of time (in milliseconds) the
- * <code>borrowObject()</code> method should block before throwing an
+ * {@code borrowObject()} method should block before throwing an
* exception when the pool is exhausted and
* {@link #getBlockWhenExhausted} is true. When less than 0, the
- * <code>borrowObject()</code> method may block indefinitely.
+ * {@code borrowObject()} method may block indefinitely.
*
* @param maxWaitMillis the maximum number of milliseconds
- * <code>borrowObject()</code> will block or negative
+ * {@code borrowObject()} will block or negative
* for indefinitely.
*
* @see #getMaxWaitMillis
@@ -286,8 +286,8 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject {
* from the pool, or as a FIFO (first in, first out) queue, where the pool
* always returns the oldest object in the idle object pool.
*
- * @return <code>true</code> if the pool is configured with LIFO behaviour
- * or <code>false</code> if the pool is configured with FIFO
+ * @return {@code true} if the pool is configured with LIFO behaviour
+ * or {@code false} if the pool is configured with FIFO
* behaviour
*
* @see #setLifo
@@ -300,7 +300,7 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject {
* Returns whether or not the pool serves threads waiting to borrow
objects fairly.
* True means that waiting threads are served as if waiting in a FIFO
queue.
*
- * @return <code>true</code> if waiting threads are to be served
+ * @return {@code true} if waiting threads are to be served
* by the pool in arrival order
*/
public final boolean getFairness() {
@@ -313,8 +313,8 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject {
* from the pool, or as a FIFO (first in, first out) queue, where the pool
* always returns the oldest object in the idle object pool.
*
- * @param lifo <code>true</code> if the pool is to be configured with LIFO
- * behaviour or <code>false</code> if the pool is to be
+ * @param lifo {@code true} if the pool is to be configured with LIFO
+ * behaviour or {@code false} if the pool is to be
* configured with FIFO behaviour
*
* @see #getLifo()
@@ -325,13 +325,13 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject {
/**
* Returns whether objects created for the pool will be validated before
- * being returned from the <code>borrowObject()</code> method. Validation
is
- * performed by the <code>validateObject()</code> method of the factory
+ * being returned from the {@code borrowObject()} method. Validation is
+ * performed by the {@code validateObject()} method of the factory
* associated with the pool. If the object fails to validate, then
- * <code>borrowObject()</code> will fail.
+ * {@code borrowObject()} will fail.
*
- * @return <code>true</code> if newly created objects are validated before
- * being returned from the <code>borrowObject()</code> method
+ * @return {@code true} if newly created objects are validated before
+ * being returned from the {@code borrowObject()} method
*
* @see #setTestOnCreate
*
@@ -343,14 +343,14 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject {
/**
* Sets whether objects created for the pool will be validated before
- * being returned from the <code>borrowObject()</code> method. Validation
is
- * performed by the <code>validateObject()</code> method of the factory
+ * being returned from the {@code borrowObject()} method. Validation is
+ * performed by the {@code validateObject()} method of the factory
* associated with the pool. If the object fails to validate, then
- * <code>borrowObject()</code> will fail.
+ * {@code borrowObject()} will fail.
*
- * @param testOnCreate <code>true</code> if newly created objects should
be
+ * @param testOnCreate {@code true} if newly created objects should be
* validated before being returned from the
- * <code>borrowObject()</code> method
+ * {@code borrowObject()} method
*
* @see #getTestOnCreate
*
@@ -362,14 +362,14 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject {
/**
* Returns whether objects borrowed from the pool will be validated before
- * being returned from the <code>borrowObject()</code> method. Validation
is
- * performed by the <code>validateObject()</code> method of the factory
+ * being returned from the {@code borrowObject()} method. Validation is
+ * performed by the {@code validateObject()} method of the factory
* associated with the pool. If the object fails to validate, it will be
* removed from the pool and destroyed, and a new attempt will be made to
* borrow an object from the pool.
*
- * @return <code>true</code> if objects are validated before being returned
- * from the <code>borrowObject()</code> method
+ * @return {@code true} if objects are validated before being returned
+ * from the {@code borrowObject()} method
*
* @see #setTestOnBorrow
*/
@@ -379,15 +379,15 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject {
/**
* Sets whether objects borrowed from the pool will be validated before
- * being returned from the <code>borrowObject()</code> method. Validation
is
- * performed by the <code>validateObject()</code> method of the factory
+ * being returned from the {@code borrowObject()} method. Validation is
+ * performed by the {@code validateObject()} method of the factory
* associated with the pool. If the object fails to validate, it will be
* removed from the pool and destroyed, and a new attempt will be made to
* borrow an object from the pool.
*
- * @param testOnBorrow <code>true</code> if objects should be validated
+ * @param testOnBorrow {@code true} if objects should be validated
* before being returned from the
- * <code>borrowObject()</code> method
+ * {@code borrowObject()} method
*
* @see #getTestOnBorrow
*/
@@ -397,13 +397,13 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject {
/**
* Returns whether objects borrowed from the pool will be validated when
- * they are returned to the pool via the <code>returnObject()</code>
method.
- * Validation is performed by the <code>validateObject()</code> method of
+ * they are returned to the pool via the {@code returnObject()} method.
+ * Validation is performed by the {@code validateObject()} method of
* the factory associated with the pool. Returning objects that fail
validation
* are destroyed rather then being returned the pool.
*
- * @return <code>true</code> if objects are validated on return to
- * the pool via the <code>returnObject()</code> method
+ * @return {@code true} if objects are validated on return to
+ * the pool via the {@code returnObject()} method
*
* @see #setTestOnReturn
*/
@@ -413,14 +413,14 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject {
/**
* Sets whether objects borrowed from the pool will be validated when
- * they are returned to the pool via the <code>returnObject()</code>
method.
- * Validation is performed by the <code>validateObject()</code> method of
+ * they are returned to the pool via the {@code returnObject()} method.
+ * Validation is performed by the {@code validateObject()} method of
* the factory associated with the pool. Returning objects that fail
validation
* are destroyed rather then being returned the pool.
*
- * @param testOnReturn <code>true</code> if objects are validated on
+ * @param testOnReturn {@code true} if objects are validated on
* return to the pool via the
- * <code>returnObject()</code> method
+ * {@code returnObject()} method
*
* @see #getTestOnReturn
*/
@@ -432,11 +432,11 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject {
* Returns whether objects sitting idle in the pool will be validated by
the
* idle object evictor (if any - see
* {@link #setTimeBetweenEvictionRunsMillis(long)}). Validation is
performed
- * by the <code>validateObject()</code> method of the factory associated
+ * by the {@code validateObject()} method of the factory associated
* with the pool. If the object fails to validate, it will be removed from
* the pool and destroyed.
*
- * @return <code>true</code> if objects will be validated by the evictor
+ * @return {@code true} if objects will be validated by the evictor
*
* @see #setTestWhileIdle
* @see #setTimeBetweenEvictionRunsMillis
@@ -449,14 +449,14 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject {
* Returns whether objects sitting idle in the pool will be validated by
the
* idle object evictor (if any - see
* {@link #setTimeBetweenEvictionRunsMillis(long)}). Validation is
performed
- * by the <code>validateObject()</code> method of the factory associated
+ * by the {@code validateObject()} method of the factory associated
* with the pool. If the object fails to validate, it will be removed from
* the pool and destroyed. Note that setting this property has no effect
* unless the idle object evictor is enabled by setting
- * <code>timeBetweenEvictionRunsMillis</code> to a positive value.
+ * {@code timeBetweenEvictionRunsMillis} to a positive value.
*
* @param testWhileIdle
- * <code>true</code> so objects will be validated by the evictor
+ * {@code true} so objects will be validated by the evictor
*
* @see #getTestWhileIdle
* @see #setTimeBetweenEvictionRunsMillis
@@ -503,7 +503,7 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject {
* number of idle instances in the pool. When negative, the number of tests
* performed will be <code>ceil({@link #getNumIdle}/
* abs({@link #getNumTestsPerEvictionRun}))</code> which means that when
the
- * value is <code>-n</code> roughly one nth of the idle objects will be
+ * value is {@code -n} roughly one nth of the idle objects will be
* tested per run.
*
* @return max number of objects to examine during each evictor run
@@ -522,7 +522,7 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject {
* number of idle instances in the pool. When negative, the number of tests
* performed will be <code>ceil({@link #getNumIdle}/
* abs({@link #getNumTestsPerEvictionRun}))</code> which means that when
the
- * value is <code>-n</code> roughly one nth of the idle objects will be
+ * value is {@code -n} roughly one nth of the idle objects will be
* tested per run.
*
* @param numTestsPerEvictionRun
@@ -573,7 +573,7 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject {
* Returns the minimum amount of time an object may sit idle in the pool
* before it is eligible for eviction by the idle object evictor (if any -
* see {@link #setTimeBetweenEvictionRunsMillis(long)}),
- * with the extra condition that at least <code>minIdle</code> object
+ * with the extra condition that at least {@code minIdle} object
* instances remain in the pool. This setting is overridden by
* {@link #getMinEvictableIdleTimeMillis} (that is, if
* {@link #getMinEvictableIdleTimeMillis} is positive, then
@@ -592,7 +592,7 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject {
* Sets the minimum amount of time an object may sit idle in the pool
* before it is eligible for eviction by the idle object evictor (if any -
* see {@link #setTimeBetweenEvictionRunsMillis(long)}),
- * with the extra condition that at least <code>minIdle</code> object
+ * with the extra condition that at least {@code minIdle} object
* instances remain in the pool. This setting is overridden by
* {@link #getMinEvictableIdleTimeMillis} (that is, if
* {@link #getMinEvictableIdleTimeMillis} is positive, then
@@ -732,18 +732,18 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject {
/**
* Has this pool instance been closed.
- * @return <code>true</code> when this pool has been closed.
+ * @return {@code true} when this pool has been closed.
*/
public final boolean isClosed() {
return closed;
}
/**
- * <p>Perform <code>numTests</code> idle object eviction tests, evicting
+ * <p>Perform {@code numTests} idle object eviction tests, evicting
* examined objects that meet the criteria for eviction. If
- * <code>testWhileIdle</code> is true, examined objects are validated
+ * {@code testWhileIdle} is true, examined objects are validated
* when visited (and removed if invalid); otherwise only objects that
- * have been idle for more than <code>minEvicableIdleTimeMillis</code>
+ * have been idle for more than {@code minEvicableIdleTimeMillis}
* are removed.</p>
*
* @throws Exception when there is a problem evicting idle objects.
@@ -811,7 +811,7 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject {
/**
* Provides the name under which the pool has been registered with the
- * platform MBean server or <code>null</code> if the pool has not been
+ * platform MBean server or {@code null} if the pool has not been
* registered.
* @return the JMX name
*/
@@ -879,7 +879,7 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject {
/**
* The total number of objects destroyed by this pool as a result of
failing
- * validation during <code>borrowObject()</code> over the lifetime of the
+ * validation during {@code borrowObject()} over the lifetime of the
* pool.
* @return validation destroyed object count
*/
@@ -935,7 +935,7 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject {
* The listener used (if any) to receive notifications of exceptions
* unavoidably swallowed by the pool.
*
- * @return The listener or <code>null</code> for no listener
+ * @return The listener or {@code null} for no listener
*/
public final SwallowedExceptionListener getSwallowedExceptionListener() {
return swallowedExceptionListener;
@@ -945,7 +945,7 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject {
* The listener used (if any) to receive notifications of exceptions
* unavoidably swallowed by the pool.
*
- * @param swallowedExceptionListener The listener or <code>null</code>
+ * @param swallowedExceptionListener The listener or {@code null}
* for no listener
*/
public final void setSwallowedExceptionListener(
@@ -1037,7 +1037,7 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject {
/**
* Registers the pool with the platform MBean server.
* The registered name will be
- * <code>jmxNameBase + jmxNamePrefix + i</code> where i is the least
+ * {@code jmxNameBase + jmxNamePrefix + i} where i is the least
* integer greater than or equal to 1 such that the name is not already
* registered. Swallows MBeanRegistrationException,
NotCompliantMBeanException
* returning null.
diff --git
a/src/main/java/org/apache/commons/pool2/impl/BaseObjectPoolConfig.java
b/src/main/java/org/apache/commons/pool2/impl/BaseObjectPoolConfig.java
index d603c85..548fe57 100644
--- a/src/main/java/org/apache/commons/pool2/impl/BaseObjectPoolConfig.java
+++ b/src/main/java/org/apache/commons/pool2/impl/BaseObjectPoolConfig.java
@@ -148,7 +148,7 @@ public abstract class BaseObjectPoolConfig<T> extends
BaseObject implements Clon
/**
* The default value for the base name to use to name JMX enabled pools
- * created with a configuration instance. The default is <code>null</code>
+ * created with a configuration instance. The default is {@code null}
* which means the pool will provide the base name to use.
* @see GenericObjectPool#getJmxName()
* @see GenericKeyedObjectPool#getJmxName()
@@ -665,7 +665,7 @@ public abstract class BaseObjectPoolConfig<T> extends
BaseObject implements Clon
/**
* Gets the value of the JMX name base that will be used as part of the
* name assigned to JMX enabled pools created with this configuration
- * instance. A value of <code>null</code> means that the pool will define
+ * instance. A value of {@code null} means that the pool will define
* the JMX name base.
*
* @return The current setting of {@code jmxNameBase} for this
@@ -678,7 +678,7 @@ public abstract class BaseObjectPoolConfig<T> extends
BaseObject implements Clon
/**
* Sets the value of the JMX name base that will be used as part of the
* name assigned to JMX enabled pools created with this configuration
- * instance. A value of <code>null</code> means that the pool will define
+ * instance. A value of {@code null} means that the pool will define
* the JMX name base.
*
* @param jmxNameBase The new setting of {@code jmxNameBase}
diff --git
a/src/main/java/org/apache/commons/pool2/impl/DefaultPooledObjectInfoMBean.java
b/src/main/java/org/apache/commons/pool2/impl/DefaultPooledObjectInfoMBean.java
index 6482a8a..8e4414a 100644
---
a/src/main/java/org/apache/commons/pool2/impl/DefaultPooledObjectInfoMBean.java
+++
b/src/main/java/org/apache/commons/pool2/impl/DefaultPooledObjectInfoMBean.java
@@ -42,7 +42,7 @@ public interface DefaultPooledObjectInfoMBean {
* Obtain the time that pooled object was created.
*
* @return The creation time for the pooled object formatted as
- * <code>yyyy-MM-dd HH:mm:ss Z</code>
+ * {@code yyyy-MM-dd HH:mm:ss Z}
*/
String getCreateTimeFormatted();
@@ -58,7 +58,7 @@ public interface DefaultPooledObjectInfoMBean {
* Obtain the time that pooled object was last borrowed.
*
* @return The last borrowed time for the pooled object formated as
- * <code>yyyy-MM-dd HH:mm:ss Z</code>
+ * {@code yyyy-MM-dd HH:mm:ss Z}
*/
String getLastBorrowTimeFormatted();
@@ -83,7 +83,7 @@ public interface DefaultPooledObjectInfoMBean {
* Obtain the time that pooled object was last returned.
*
* @return The last returned time for the pooled object formated as
- * <code>yyyy-MM-dd HH:mm:ss Z</code>
+ * {@code yyyy-MM-dd HH:mm:ss Z}
*/
String getLastReturnTimeFormatted();
diff --git a/src/main/java/org/apache/commons/pool2/impl/EvictionPolicy.java
b/src/main/java/org/apache/commons/pool2/impl/EvictionPolicy.java
index a8953bf..ee14f58 100644
--- a/src/main/java/org/apache/commons/pool2/impl/EvictionPolicy.java
+++ b/src/main/java/org/apache/commons/pool2/impl/EvictionPolicy.java
@@ -37,8 +37,8 @@ public interface EvictionPolicy<T> {
* @param underTest The pooled object being tested for eviction
* @param idleCount The current number of idle objects in the pool
including
* the object under test
- * @return <code>true</code> if the object should be evicted, otherwise
- * <code>false</code>
+ * @return {@code true} if the object should be evicted, otherwise
+ * {@code false}
*/
boolean evict(EvictionConfig config, PooledObject<T> underTest, int
idleCount);
}
diff --git
a/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java
b/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java
index f78a695..310c4e7 100644
--- a/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java
@@ -41,16 +41,16 @@ import org.apache.commons.pool2.PooledObjectState;
import org.apache.commons.pool2.SwallowedExceptionListener;
/**
- * A configurable <code>KeyedObjectPool</code> implementation.
+ * A configurable {@code KeyedObjectPool} implementation.
* <p>
* When coupled with the appropriate {@link KeyedPooledObjectFactory},
- * <code>GenericKeyedObjectPool</code> provides robust pooling functionality
for
- * keyed objects. A <code>GenericKeyedObjectPool</code> can be viewed as a map
+ * {@code GenericKeyedObjectPool} provides robust pooling functionality for
+ * keyed objects. A {@code GenericKeyedObjectPool} can be viewed as a map
* of sub-pools, keyed on the (unique) key values provided to the
* {@link #preparePool preparePool}, {@link #addObject addObject} or
* {@link #borrowObject borrowObject} methods. Each time a new key value is
* provided to one of these methods, a sub-new pool is created under the given
- * key to be managed by the containing <code>GenericKeyedObjectPool.</code>
+ * key to be managed by the containing {@code GenericKeyedObjectPool.}
* </p>
* <p>
* Note that the current implementation uses a ConcurrentHashMap which uses
@@ -86,7 +86,7 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
implements KeyedObjectPool<K, T>, GenericKeyedObjectPoolMXBean<K> {
/**
- * Create a new <code>GenericKeyedObjectPool</code> using defaults from
+ * Create a new {@code GenericKeyedObjectPool} using defaults from
* {@link GenericKeyedObjectPoolConfig}.
* @param factory the factory to be used to create entries
*/
@@ -95,7 +95,7 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
}
/**
- * Create a new <code>GenericKeyedObjectPool</code> using a specific
+ * Create a new {@code GenericKeyedObjectPool} using a specific
* configuration.
*
* @param factory the factory to be used to create entries
@@ -279,7 +279,7 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
* associated with the given key, then an idle instance will be selected
* based on the value of {@link #getLifo()}, activated and returned. If
* activation fails, or {@link #getTestOnBorrow() testOnBorrow} is set to
- * <code>true</code> and validation fails, the instance is destroyed and
the
+ * {@code true} and validation fails, the instance is destroyed and the
* next available instance is examined. This continues until either a
valid
* instance is returned or there are no more idle instances available.
* <p>
@@ -287,24 +287,24 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
* the given key, behavior depends on the {@link #getMaxTotalPerKey()
* maxTotalPerKey}, {@link #getMaxTotal() maxTotal}, and (if applicable)
* {@link #getBlockWhenExhausted()} and the value passed in to the
- * <code>borrowMaxWaitMillis</code> parameter. If the number of instances
checked
+ * {@code borrowMaxWaitMillis} parameter. If the number of instances
checked
* out from the sub-pool under the given key is less than
- * <code>maxTotalPerKey</code> and the total number of instances in
- * circulation (under all keys) is less than <code>maxTotal</code>, a new
+ * {@code maxTotalPerKey} and the total number of instances in
+ * circulation (under all keys) is less than {@code maxTotal}, a new
* instance is created, activated and (if applicable) validated and
returned
- * to the caller. If validation fails, a
<code>NoSuchElementException</code>
+ * to the caller. If validation fails, a {@code NoSuchElementException}
* will be thrown.
* <p>
* If the associated sub-pool is exhausted (no available idle instances and
* no capacity to create new ones), this method will either block
* ({@link #getBlockWhenExhausted()} is true) or throw a
- * <code>NoSuchElementException</code>
+ * {@code NoSuchElementException}
* ({@link #getBlockWhenExhausted()} is false).
* The length of time that this method will block when
* {@link #getBlockWhenExhausted()} is true is determined by the value
- * passed in to the <code>borrowMaxWait</code> parameter.
+ * passed in to the {@code borrowMaxWait} parameter.
* <p>
- * When <code>maxTotal</code> is set to a positive value and this method is
+ * When {@code maxTotal} is set to a positive value and this method is
* invoked when at the limit with no idle instances available under the
requested
* key, an attempt is made to create room by clearing the oldest 15% of the
* elements from the keyed sub-pools.
@@ -547,7 +547,7 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
* {@inheritDoc}
* <p>
* Activation of this method decrements the active count associated with
- * the given keyed pool and attempts to destroy <code>obj.</code>
+ * the given keyed pool and attempts to destroy {@code obj.}
*
* @param key pool key
* @param obj instance to invalidate
@@ -608,7 +608,7 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
/**
* Clears the specified sub-pool, removing all pooled instances
- * corresponding to the given <code>key</code>. Exceptions encountered
+ * corresponding to the given {@code key}. Exceptions encountered
* destroying idle instances are swallowed but notified via a
* {@link SwallowedExceptionListener}.
*
@@ -1239,7 +1239,7 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
/**
* Create an object using the {@link KeyedPooledObjectFactory#makeObject
* factory}, passivate it, and then place it in the idle object pool.
- * <code>addObject</code> is useful for "pre-loading" a pool with idle
+ * {@code addObject} is useful for "pre-loading" a pool with idle
* objects.
*
* @param key the key a new instance should be added to
diff --git a/src/main/java/org/apache/commons/pool2/impl/GenericObjectPool.java
b/src/main/java/org/apache/commons/pool2/impl/GenericObjectPool.java
index 56d4668..09c7c5c 100644
--- a/src/main/java/org/apache/commons/pool2/impl/GenericObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/impl/GenericObjectPool.java
@@ -39,7 +39,7 @@ import java.util.concurrent.atomic.AtomicLong;
* A configurable {@link ObjectPool} implementation.
* <p>
* When coupled with the appropriate {@link PooledObjectFactory},
- * <code>GenericObjectPool</code> provides robust pooling functionality for
+ * {@code GenericObjectPool} provides robust pooling functionality for
* arbitrary objects.
* </p>
* <p>
@@ -57,10 +57,10 @@ import java.util.concurrent.atomic.AtomicLong;
* returned before the configured
* {@link AbandonedConfig#getRemoveAbandonedTimeout() removeAbandonedTimeout}.
* Abandoned object removal can be configured to happen when
- * <code>borrowObject</code> is invoked and the pool is close to starvation, or
+ * {@code borrowObject} is invoked and the pool is close to starvation, or
* it can be executed by the idle object evictor, or both. If pooled objects
* implement the {@link TrackedUse} interface, their last use will be queried
- * using the <code>getLastUsed</code> method on that interface; otherwise
+ * using the {@code getLastUsed} method on that interface; otherwise
* abandonment is determined by how long an object has been checked out from
* the pool.
* </p>
@@ -83,7 +83,7 @@ public class GenericObjectPool<T> extends
BaseGenericObjectPool<T>
implements ObjectPool<T>, GenericObjectPoolMXBean, UsageTracking<T> {
/**
- * Creates a new <code>GenericObjectPool</code> using defaults from
+ * Creates a new {@code GenericObjectPool} using defaults from
* {@link GenericObjectPoolConfig}.
*
* @param factory The object factory to be used to create object instances
@@ -94,7 +94,7 @@ public class GenericObjectPool<T> extends
BaseGenericObjectPool<T>
}
/**
- * Creates a new <code>GenericObjectPool</code> using a specific
+ * Creates a new {@code GenericObjectPool} using a specific
* configuration.
*
* @param factory The object factory to be used to create object
instances
@@ -121,7 +121,7 @@ public class GenericObjectPool<T> extends
BaseGenericObjectPool<T>
}
/**
- * Creates a new <code>GenericObjectPool</code> that tracks and destroys
+ * Creates a new {@code GenericObjectPool} that tracks and destroys
* objects that are checked out, but never returned to the pool.
*
* @param factory The object factory to be used to create object
instances
@@ -361,7 +361,7 @@ public class GenericObjectPool<T> extends
BaseGenericObjectPool<T>
* If there is one or more idle instance available in the pool, then an
* idle instance will be selected based on the value of {@link #getLifo()},
* activated and returned. If activation fails, or {@link
#getTestOnBorrow()
- * testOnBorrow} is set to <code>true</code> and validation fails, the
+ * testOnBorrow} is set to {@code true} and validation fails, the
* instance is destroyed and the next available instance is examined. This
* continues until either a valid instance is returned or there are no more
* idle instances available.
@@ -370,20 +370,20 @@ public class GenericObjectPool<T> extends
BaseGenericObjectPool<T>
* If there are no idle instances available in the pool, behavior depends
on
* the {@link #getMaxTotal() maxTotal}, (if applicable)
* {@link #getBlockWhenExhausted()} and the value passed in to the
- * <code>borrowMaxWaitMillis</code> parameter. If the number of instances
- * checked out from the pool is less than <code>maxTotal,</code> a new
+ * {@code borrowMaxWaitMillis} parameter. If the number of instances
+ * checked out from the pool is less than {@code maxTotal,} a new
* instance is created, activated and (if applicable) validated and
returned
- * to the caller. If validation fails, a
<code>NoSuchElementException</code>
+ * to the caller. If validation fails, a {@code NoSuchElementException}
* is thrown.
* </p>
* <p>
* If the pool is exhausted (no available idle instances and no capacity to
* create new ones), this method will either block (if
* {@link #getBlockWhenExhausted()} is true) or throw a
- * <code>NoSuchElementException</code> (if
+ * {@code NoSuchElementException} (if
* {@link #getBlockWhenExhausted()} is false). The length of time that this
* method will block when {@link #getBlockWhenExhausted()} is true is
- * determined by the value passed in to the
<code>borrowMaxWaitMillis</code>
+ * determined by the value passed in to the {@code borrowMaxWaitMillis}
* parameter.
* </p>
* <p>
diff --git
a/src/main/java/org/apache/commons/pool2/impl/SoftReferenceObjectPool.java
b/src/main/java/org/apache/commons/pool2/impl/SoftReferenceObjectPool.java
index 05592f5..5b9a4a6 100644
--- a/src/main/java/org/apache/commons/pool2/impl/SoftReferenceObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/impl/SoftReferenceObjectPool.java
@@ -46,7 +46,7 @@ public class SoftReferenceObjectPool<T> extends
BaseObjectPool<T> {
/**
* Queue of broken references that might be able to be removed from
- * <code>_pool</code>. This is used to help {@link #getNumIdle()} be more
+ * {@code _pool}. This is used to help {@link #getNumIdle()} be more
* accurate with minimal performance overhead.
*/
private final ReferenceQueue<T> refQueue = new ReferenceQueue<>();
@@ -70,7 +70,7 @@ public class SoftReferenceObjectPool<T> extends
BaseObjectPool<T> {
new ArrayList<>();
/**
- * Create a <code>SoftReferenceObjectPool</code> with the specified
factory.
+ * Create a {@code SoftReferenceObjectPool} with the specified factory.
*
* @param factory object factory to use.
*/
@@ -95,12 +95,12 @@ public class SoftReferenceObjectPool<T> extends
BaseObjectPool<T> {
* destroyed} and another instance is retrieved from the pool, validated
and
* activated. This process continues until either the pool is empty or an
* instance passes validation. If the pool is empty on activation or it
does
- * not contain any valid instances, the factory's <code>makeObject</code>
+ * not contain any valid instances, the factory's {@code makeObject}
* method is used to create a new instance. If the created instance either
* raises an exception on activation or fails validation,
- * <code>NoSuchElementException</code> is thrown. Exceptions thrown by
- * <code>MakeObject</code> are propagated to the caller; but other than
- * <code>ThreadDeath</code> or <code>VirtualMachineError</code>, exceptions
+ * {@code NoSuchElementException} is thrown. Exceptions thrown by
+ * {@code MakeObject} are propagated to the caller; but other than
+ * {@code ThreadDeath} or {@code VirtualMachineError}, exceptions
* generated by activation, validation or destroy methods are swallowed
* silently.
*
@@ -257,8 +257,8 @@ public class SoftReferenceObjectPool<T> extends
BaseObjectPool<T> {
* validation fails, the new instance is
* {@link PooledObjectFactory#destroyObject(
* org.apache.commons.pool2.PooledObject) destroyed}. Exceptions
- * generated by the factory <code>makeObject</code> or
- * <code>passivate</code> are propagated to the caller. Exceptions
+ * generated by the factory {@code makeObject} or
+ * {@code passivate} are propagated to the caller. Exceptions
* destroying instances are silently swallowed.
*
* @throws IllegalStateException
diff --git a/src/test/java/org/apache/commons/pool2/TestKeyedObjectPool.java
b/src/test/java/org/apache/commons/pool2/TestKeyedObjectPool.java
index 0405d64..e6ce9f0 100644
--- a/src/test/java/org/apache/commons/pool2/TestKeyedObjectPool.java
+++ b/src/test/java/org/apache/commons/pool2/TestKeyedObjectPool.java
@@ -34,7 +34,7 @@ import org.junit.Test;
public abstract class TestKeyedObjectPool {
/**
- * Create an <code>KeyedObjectPool</code> with the specified factory.
+ * Create an {@code KeyedObjectPool} with the specified factory.
* The pool should be in a default configuration and conform to the
expected
* behaviors described in {@link KeyedObjectPool}.
* Generally speaking there should be no limits on the various object
counts.
diff --git a/src/test/java/org/apache/commons/pool2/TestObjectPool.java
b/src/test/java/org/apache/commons/pool2/TestObjectPool.java
index 3f317cb..d46bc40 100644
--- a/src/test/java/org/apache/commons/pool2/TestObjectPool.java
+++ b/src/test/java/org/apache/commons/pool2/TestObjectPool.java
@@ -35,7 +35,7 @@ import java.util.NoSuchElementException;
public abstract class TestObjectPool {
/**
- * Create an <code>ObjectPool</code> with the specified factory.
+ * Create an {@code ObjectPool} with the specified factory.
* The pool should be in a default configuration and conform to the
expected
* behaviors described in {@link ObjectPool}.
* Generally speaking there should be no limits on the various object
counts.
diff --git a/src/test/java/org/apache/commons/pool2/Waiter.java
b/src/test/java/org/apache/commons/pool2/Waiter.java
index 0c187b8..5cfc226 100644
--- a/src/test/java/org/apache/commons/pool2/Waiter.java
+++ b/src/test/java/org/apache/commons/pool2/Waiter.java
@@ -75,7 +75,7 @@ public class Waiter {
*
* <p>{@link WaiterFactory#activateObject(PooledObject)} and
* {@link WaiterFactory#passivateObject(PooledObject)} invoke this method
on
- * their actual parameter, passing <code>true</code> and
<code>false</code>,
+ * their actual parameter, passing {@code true} and {@code false},
* respectively.</p>
*
* @param active new active state
@@ -128,7 +128,7 @@ public class Waiter {
*
* <p>When an instance is created, and each subsequent time it is
passivated,
* the {@link #getLastPassivated() lastPassivated} property is updated
with the
- * current time. When the next activation occurs,
<code>lastIdleTime</code> is
+ * current time. When the next activation occurs, {@code lastIdleTime} is
* updated with the elapsed time since passivation.<p>
*
* @return last idle time
diff --git
a/src/test/java/org/apache/commons/pool2/impl/TestGenericKeyedObjectPool.java
b/src/test/java/org/apache/commons/pool2/impl/TestGenericKeyedObjectPool.java
index 29a0cf0..b8f4b2d 100644
---
a/src/test/java/org/apache/commons/pool2/impl/TestGenericKeyedObjectPool.java
+++
b/src/test/java/org/apache/commons/pool2/impl/TestGenericKeyedObjectPool.java
@@ -546,8 +546,8 @@ public class TestGenericKeyedObjectPool extends
TestKeyedObjectPool {
}
/**
- * Kicks off <code>numThreads</code> test threads, each of which will go
- * through <code>iterations</code> borrow-return cycles with random delay
+ * Kicks off {@code numThreads} test threads, each of which will go
+ * through {@code iterations} borrow-return cycles with random delay
* times <= delay in between.
*
* @param <T> Type of object in pool
