Repository: commons-pool Updated Branches: refs/heads/master 7cb6b675e -> e206c89d6
[POOL-328] Documentation with repeated words (sources, tests, and examples). Closes #2. Project: http://git-wip-us.apache.org/repos/asf/commons-pool/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-pool/commit/e206c89d Tree: http://git-wip-us.apache.org/repos/asf/commons-pool/tree/e206c89d Diff: http://git-wip-us.apache.org/repos/asf/commons-pool/diff/e206c89d Branch: refs/heads/master Commit: e206c89d650f472d9837e743131c55e164872ae7 Parents: 7cb6b67 Author: Lorenzo Solano Martinez <notificati...@github.com> Authored: Mon Jul 31 12:44:47 2017 -0700 Committer: Gary Gregory <ggreg...@apache.org> Committed: Mon Jul 31 12:44:47 2017 -0700 ---------------------------------------------------------------------- src/changes/changes.xml | 3 +++ .../apache/commons/pool2/BaseKeyedPooledObjectFactory.java | 8 ++++---- src/main/java/org/apache/commons/pool2/PooledObject.java | 4 ++-- .../apache/commons/pool2/impl/GenericKeyedObjectPool.java | 4 ++-- .../org/apache/commons/pool2/impl/GenericObjectPool.java | 4 ++-- src/site/xdoc/examples.xml | 2 +- .../commons/pool2/impl/TestGenericKeyedObjectPool.java | 2 +- .../org/apache/commons/pool2/impl/TestGenericObjectPool.java | 2 +- 8 files changed, 16 insertions(+), 13 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-pool/blob/e206c89d/src/changes/changes.xml ---------------------------------------------------------------------- diff --git a/src/changes/changes.xml b/src/changes/changes.xml index e251919..e9ced79 100644 --- a/src/changes/changes.xml +++ b/src/changes/changes.xml @@ -44,6 +44,9 @@ The <action> type attribute can be add,update,fix,remove. </properties> <body> <release version="2.4.3" date="TBD" description="TBD"> + <action dev="ggregory" issue="POOL-328" type="fix" due-to="Lorenzo Solano Martinez"> + Documentation with repeated words (sources, tests, and examples). + </action> <action dev="ggregory" issue="POOL-317" type="fix" due-to="KeiichiFujino"> Correction of default value of softMinEvictableIdleTimeMillis in BaseObjectPoolConfig. </action> http://git-wip-us.apache.org/repos/asf/commons-pool/blob/e206c89d/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java b/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java index 2f9edf9..36b6327 100644 --- a/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java +++ b/src/main/java/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.java @@ -68,7 +68,7 @@ public abstract class BaseKeyedPooledObjectFactory<K,V> extends BaseObject * The default implementation is a no-op. * * @param key the key used when selecting the instance - * @param p a {@code PooledObject} wrapping the the instance to be destroyed + * @param p a {@code PooledObject} wrapping the instance to be destroyed */ @Override public void destroyObject(final K key, final PooledObject<V> p) @@ -81,7 +81,7 @@ public abstract class BaseKeyedPooledObjectFactory<K,V> extends BaseObject * The default implementation always returns {@code true}. * * @param key the key used when selecting the object - * @param p a {@code PooledObject} wrapping the the instance to be validated + * @param p a {@code PooledObject} wrapping the instance to be validated * @return always <code>true</code> in the default implementation */ @Override @@ -95,7 +95,7 @@ public abstract class BaseKeyedPooledObjectFactory<K,V> extends BaseObject * The default implementation is a no-op. * * @param key the key used when selecting the object - * @param p a {@code PooledObject} wrapping the the instance to be activated + * @param p a {@code PooledObject} wrapping the instance to be activated */ @Override public void activateObject(final K key, final PooledObject<V> p) @@ -108,7 +108,7 @@ public abstract class BaseKeyedPooledObjectFactory<K,V> extends BaseObject * The default implementation is a no-op. * * @param key the key used when selecting the object - * @param p a {@code PooledObject} wrapping the the instance to be passivated + * @param p a {@code PooledObject} wrapping the instance to be passivated */ @Override public void passivateObject(final K key, final PooledObject<V> p) http://git-wip-us.apache.org/repos/asf/commons-pool/blob/e206c89d/src/main/java/org/apache/commons/pool2/PooledObject.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/pool2/PooledObject.java b/src/main/java/org/apache/commons/pool2/PooledObject.java index 529a91f..2dc2ed0 100644 --- a/src/main/java/org/apache/commons/pool2/PooledObject.java +++ b/src/main/java/org/apache/commons/pool2/PooledObject.java @@ -50,7 +50,7 @@ public interface PooledObject<T> extends Comparable<PooledObject<T>> { long getCreateTime(); /** - * Obtain the time in milliseconds that this object last spent in the the + * Obtain the time in milliseconds that this object last spent in the * active state (it may still be active in which case subsequent calls will * return an increased value). * @@ -59,7 +59,7 @@ public interface PooledObject<T> extends Comparable<PooledObject<T>> { long getActiveTimeMillis(); /** - * Obtain the time in milliseconds that this object last spend in the the + * Obtain the time in milliseconds that this object last spend in the * idle state (it may still be idle in which case subsequent calls will * return an increased value). * http://git-wip-us.apache.org/repos/asf/commons-pool/blob/e206c89d/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java ---------------------------------------------------------------------- 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 59ba113..d0cc8a8 100644 --- a/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java +++ b/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java @@ -151,7 +151,7 @@ implements KeyedObjectPool<K,T>, GenericKeyedObjectPoolMXBean<K> { * If maxIdlePerKey is set too low on heavily loaded systems it is possible * you will see objects being destroyed and almost immediately new objects * being created. This is a result of the active threads momentarily - * returning objects faster than they are requesting them them, causing the + * returning objects faster than they are requesting them, causing the * number of idle objects to rise above maxIdlePerKey. The best value for * maxIdlePerKey for heavily loaded system will vary but the default is a * good starting point. @@ -171,7 +171,7 @@ implements KeyedObjectPool<K,T>, GenericKeyedObjectPoolMXBean<K> { * If maxIdlePerKey is set too low on heavily loaded systems it is possible * you will see objects being destroyed and almost immediately new objects * being created. This is a result of the active threads momentarily - * returning objects faster than they are requesting them them, causing the + * returning objects faster than they are requesting them, causing the * number of idle objects to rise above maxIdlePerKey. The best value for * maxIdlePerKey for heavily loaded system will vary but the default is a * good starting point. http://git-wip-us.apache.org/repos/asf/commons-pool/blob/e206c89d/src/main/java/org/apache/commons/pool2/impl/GenericObjectPool.java ---------------------------------------------------------------------- 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 816c6cf..4d499c8 100644 --- a/src/main/java/org/apache/commons/pool2/impl/GenericObjectPool.java +++ b/src/main/java/org/apache/commons/pool2/impl/GenericObjectPool.java @@ -143,7 +143,7 @@ public class GenericObjectPool<T> extends BaseGenericObjectPool<T> * is set too low on heavily loaded systems it is possible you will see * objects being destroyed and almost immediately new objects being created. * This is a result of the active threads momentarily returning objects - * faster than they are requesting them them, causing the number of idle + * faster than they are requesting them, causing the number of idle * objects to rise above maxIdle. The best value for maxIdle for heavily * loaded system will vary but the default is a good starting point. * @@ -162,7 +162,7 @@ public class GenericObjectPool<T> extends BaseGenericObjectPool<T> * is set too low on heavily loaded systems it is possible you will see * objects being destroyed and almost immediately new objects being created. * This is a result of the active threads momentarily returning objects - * faster than they are requesting them them, causing the number of idle + * faster than they are requesting them, causing the number of idle * objects to rise above maxIdle. The best value for maxIdle for heavily * loaded system will vary but the default is a good starting point. * http://git-wip-us.apache.org/repos/asf/commons-pool/blob/e206c89d/src/site/xdoc/examples.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/examples.xml b/src/site/xdoc/examples.xml index 763e5c9..78f8f5b 100644 --- a/src/site/xdoc/examples.xml +++ b/src/site/xdoc/examples.xml @@ -61,7 +61,7 @@ public class ReaderUtil { } </source> <p> - For the sake of this example, let's assume we want to to pool the <code>StringBuffer</code>s + For the sake of this example, let's assume we want to pool the <code>StringBuffer</code>s used to buffer the <code>Reader</code>'s contents. (A pool of <code>StringBuffer</code>s may or may not be useful in practice. We're just using it as a simple example here.) </p> http://git-wip-us.apache.org/repos/asf/commons-pool/blob/e206c89d/src/test/java/org/apache/commons/pool2/impl/TestGenericKeyedObjectPool.java ---------------------------------------------------------------------- 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 86f35c5..4b8a12c 100644 --- a/src/test/java/org/apache/commons/pool2/impl/TestGenericKeyedObjectPool.java +++ b/src/test/java/org/apache/commons/pool2/impl/TestGenericKeyedObjectPool.java @@ -2248,7 +2248,7 @@ public class TestGenericKeyedObjectPool extends TestKeyedObjectPool { /** * Verifies that if a borrow of a new key is blocked because maxTotal has - * been reached, that that borrow continues once another object is returned. + * been reached, that borrow continues once another object is returned. * * JIRA: POOL-310 */ http://git-wip-us.apache.org/repos/asf/commons-pool/blob/e206c89d/src/test/java/org/apache/commons/pool2/impl/TestGenericObjectPool.java ---------------------------------------------------------------------- diff --git a/src/test/java/org/apache/commons/pool2/impl/TestGenericObjectPool.java b/src/test/java/org/apache/commons/pool2/impl/TestGenericObjectPool.java index 9bb48cb..17551f3 100644 --- a/src/test/java/org/apache/commons/pool2/impl/TestGenericObjectPool.java +++ b/src/test/java/org/apache/commons/pool2/impl/TestGenericObjectPool.java @@ -765,7 +765,7 @@ public class TestGenericObjectPool extends TestBaseObjectPool { /** * This is the test case for POOL-263. It is disabled since it will always * pass without artificial delay being injected into GOP.returnObject() and - * a way to this this hasn't currently been found that doesn't involve + * a way to this hasn't currently been found that doesn't involve * polluting the GOP implementation. The artificial delay needs to be * inserted just before the final call to isLifo() in the returnObject() * method.
