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 2010/07/19 02:19:55 UTC
svn commit: r965334 -
/commons/proper/pool/trunk/src/java/org/apache/commons/pool/BaseKeyedObjectPool.java
Author: psteitz
Date: Mon Jul 19 00:19:55 2010
New Revision: 965334
URL: http://svn.apache.org/viewvc?rev=965334&view=rev
Log:
Javadoc cleanup.
Modified:
commons/proper/pool/trunk/src/java/org/apache/commons/pool/BaseKeyedObjectPool.java
Modified: commons/proper/pool/trunk/src/java/org/apache/commons/pool/BaseKeyedObjectPool.java
URL: http://svn.apache.org/viewvc/commons/proper/pool/trunk/src/java/org/apache/commons/pool/BaseKeyedObjectPool.java?rev=965334&r1=965333&r2=965334&view=diff
==============================================================================
--- commons/proper/pool/trunk/src/java/org/apache/commons/pool/BaseKeyedObjectPool.java (original)
+++ commons/proper/pool/trunk/src/java/org/apache/commons/pool/BaseKeyedObjectPool.java Mon Jul 19 00:19:55 2010
@@ -28,7 +28,15 @@ package org.apache.commons.pool;
* @since Pool 1.0
*/
public abstract class BaseKeyedObjectPool implements KeyedObjectPool {
+
+ /**
+ * {@inheritDoc}
+ */
public abstract Object borrowObject(Object key) throws Exception;
+
+ /**
+ * {@inheritDoc}
+ */
public abstract void returnObject(Object key, Object obj) throws Exception;
/**
@@ -51,6 +59,8 @@ public abstract class BaseKeyedObjectPoo
* Not supported in this base implementation.
* Always throws an {@link UnsupportedOperationException},
* subclasses should override this behavior.
+ * @param key ignored
+ * @throws UnsupportedOperationException
*/
public void addObject(Object key) throws Exception, UnsupportedOperationException {
throw new UnsupportedOperationException();
@@ -59,6 +69,7 @@ public abstract class BaseKeyedObjectPoo
/**
* Not supported in this base implementation.
* @return a negative value.
+ * @param key ignored
*/
public int getNumIdle(Object key) throws UnsupportedOperationException {
return -1;
@@ -67,6 +78,7 @@ public abstract class BaseKeyedObjectPoo
/**
* Not supported in this base implementation.
* @return a negative value.
+ * @param key ignored
*/
public int getNumActive(Object key) throws UnsupportedOperationException {
return -1;
@@ -90,6 +102,7 @@ public abstract class BaseKeyedObjectPoo
/**
* Not supported in this base implementation.
+ * @throws UnsupportedOpereationException
*/
public void clear() throws Exception, UnsupportedOperationException {
throw new UnsupportedOperationException();
@@ -97,6 +110,8 @@ public abstract class BaseKeyedObjectPoo
/**
* Not supported in this base implementation.
+ * @param key ignored
+ * @throws UnsupportedOperationException
*/
public void clear(Object key) throws Exception, UnsupportedOperationException {
throw new UnsupportedOperationException();
@@ -114,6 +129,7 @@ public abstract class BaseKeyedObjectPoo
* Not supported in this base implementation.
* Always throws an {@link UnsupportedOperationException},
* subclasses should override this behavior.
+ * @param factory the new KeyedPoolableObjectFactory
* @deprecated to be removed in pool 2.0
*/
public void setFactory(KeyedPoolableObjectFactory factory) throws IllegalStateException, UnsupportedOperationException {
@@ -141,5 +157,6 @@ public abstract class BaseKeyedObjectPoo
}
}
+ /** Whether or not the pool is close */
private volatile boolean closed = false;
}