Return-Path: X-Original-To: apmail-commons-commits-archive@minotaur.apache.org Delivered-To: apmail-commons-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id DB256C269 for ; Sat, 5 May 2012 10:14:31 +0000 (UTC) Received: (qmail 58969 invoked by uid 500); 5 May 2012 10:14:31 -0000 Delivered-To: apmail-commons-commits-archive@commons.apache.org Received: (qmail 58910 invoked by uid 500); 5 May 2012 10:14:31 -0000 Mailing-List: contact commits-help@commons.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@commons.apache.org Delivered-To: mailing list commits@commons.apache.org Received: (qmail 58903 invoked by uid 99); 5 May 2012 10:14:31 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 05 May 2012 10:14:31 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 05 May 2012 10:14:29 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id 2A9BE238890B for ; Sat, 5 May 2012 10:14:08 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1334380 - /commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java Date: Sat, 05 May 2012 10:14:08 -0000 To: commits@commons.apache.org From: sebb@apache.org X-Mailer: svnmailer-1.0.8-patched Message-Id: <20120505101408.2A9BE238890B@eris.apache.org> Author: sebb Date: Sat May 5 10:14:07 2012 New Revision: 1334380 URL: http://svn.apache.org/viewvc?rev=1334380&view=rev Log: Javadoc Modified: commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java Modified: commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java URL: http://svn.apache.org/viewvc/commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java?rev=1334380&r1=1334379&r2=1334380&view=diff ============================================================================== --- commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java (original) +++ commons/proper/pool/trunk/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java Sat May 5 10:14:07 2012 @@ -77,6 +77,7 @@ public class GenericKeyedObjectPool /** * Create a new GenericKeyedObjectPool using defaults from * {@link GenericKeyedObjectPoolConfig}. + * @param factory the factory to be used to create entries */ public GenericKeyedObjectPool(KeyedPoolableObjectFactory factory) { this(factory, new GenericKeyedObjectPoolConfig()); @@ -86,6 +87,7 @@ public class GenericKeyedObjectPool * Create a new GenericKeyedObjectPool using a specific * configuration. * + * @param factory the factory to be used to create entries * @param config The configuration to use for this pool instance. The * configuration is used by value. Subsequent changes to * the configuration object will not be reflected in the @@ -262,6 +264,8 @@ public class GenericKeyedObjectPool /** * Equivalent to {@link #borrowObject(Object, long) borrowObject}(key, * {@link #getMaxWaitMillis()}). + *

+ * {@inheritDoc} */ @Override public T borrowObject(K key) throws Exception { @@ -612,14 +616,16 @@ public class GenericKeyedObjectPool /** - * Returns the total number of instances currently borrowed from this pool - * but not yet returned. + * {@inheritDoc} */ @Override public int getNumActive() { return numTotal.get() - getNumIdle(); } + /** + * {@inheritDoc} + */ @Override public int getNumIdle() { Iterator> iter = poolMap.values().iterator();