Index: HttpConnection.java
===================================================================
RCS file: /home/cvspublic/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpConnection.java,v
retrieving revision 1.103
diff -u -r1.103 HttpConnection.java
--- HttpConnection.java 3 Nov 2004 19:37:10 -0000 1.103
+++ HttpConnection.java 20 Dec 2004 16:08:43 -0000
@@ -1,5 +1,5 @@
/*
- * $Header: /home/cvspublic/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpConnection.java,v 1.103 2004/11/03 19:37:10 olegk Exp $
+ * $Header: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpConnection.java,v 1.103 2004/11/03 19:37:10 olegk Exp $
* $Revision: 1.103 $
* $Date: 2004/11/03 19:37:10 $
*
@@ -1162,7 +1162,12 @@
}
/**
- * Release the connection.
+ * Releases the connection. If the connection is locked or does not have a connection
+ * manager associated with it, this method has no effect. Note that it is completely safe
+ * to call this method multiple times.
+ *
+ * @see #isLocked()
+ * @see #setLocked(boolean)
*/
public void releaseConnection() {
LOG.trace("enter HttpConnection.releaseConnection()");
@@ -1177,7 +1182,10 @@
}
/**
- * @return
+ * Tests if the connection is locked. Locked connections cannot be released.
+ * An attempt to release a locked connection will have no effect.
+ *
+ * @return true if the connection is locked, false otherwise.
*
* @since 3.0
*/
@@ -1186,7 +1194,11 @@
}
/**
- * @param locked
+ * Locks or unlocks the connection. Locked connections cannot be released.
+ * An attempt to release a locked connection will have no effect.
+ *
+ * @param locked true to lock the connection, false to unlock
+ * the connection.
*
* @since 3.0
*/