You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by su...@apache.org on 2002/09/07 18:39:47 UTC
cvs commit: jakarta-commons/httpclient/src/java/org/apache/commons/httpclient HttpClient.java
sullis 2002/09/07 09:39:47
Modified: httpclient/src/java/org/apache/commons/httpclient
HttpClient.java
Log:
enhanced javadocs
Revision Changes Path
1.55 +44 -7 jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpClient.java
Index: HttpClient.java
===================================================================
RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpClient.java,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -r1.54 -r1.55
--- HttpClient.java 9 Aug 2002 04:44:16 -0000 1.54
+++ HttpClient.java 7 Sep 2002 16:39:47 -0000 1.55
@@ -170,7 +170,12 @@
* @param host the host to connect to
* @param port the port to connect to
*
+ * @see #startSession(String, int, boolean)
+ * @see #startSession(String, int, Credentials)
+ * @see #startSession(String, int, Credentials, boolean)
+ * @see #startSession(String, int, String, int)
* @see #endSession()
+ *
*/
public void startSession(String host, int port) {
log.trace("enter HttpClient.startSession(String, int)");
@@ -184,6 +189,10 @@
* @param port the port to connect to
* @param https when <code>true</code>, create an HTTPS session
*
+ * @see #startSession(String, int)
+ * @see #startSession(String, int, Credentials)
+ * @see #startSession(String, int, Credentials, boolean)
+ * @see #startSession(String, int, String, int)
* @see #endSession()
*
*/
@@ -205,7 +214,13 @@
* @param host the host to connect to
* @param port the port to connect to
* @param creds the default credentials to use
+ *
+ * @see #startSession(String, int, boolean)
+ * @see #startSession(String, int)
+ * @see #startSession(String, int, Credentials, boolean)
+ * @see #startSession(String, int, String, int)
* @see #endSession()
+ *
*/
public void startSession(String host, int port, Credentials creds) {
log.trace("enter HttpClient.startSession(String, int, Credentials)");
@@ -222,7 +237,13 @@
* @param port the port to connect to
* @param creds the default credentials to use
* @param https when <code>true</code>, create an HTTPS session
+ *
+ * @see #startSession(String, int, boolean)
+ * @see #startSession(String, int)
+ * @see #startSession(String, int, Credentials)
+ * @see #startSession(String, int, String, int)
* @see #endSession()
+ *
*/
public void startSession(String host, int port, Credentials creds, boolean https) {
log.trace("enter HttpClient.startSession(String, int, Credentials, boolean)");
@@ -249,6 +270,12 @@
* @param url the {@link URL URL} from which the protocol, host,
* and port of the session are determined
*
+ * @see #startSession(String, int, boolean)
+ * @see #startSession(String, int)
+ * @see #startSession(String, int, Credentials)
+ * @see #startSession(String, int, Credentials, boolean)
+ * @see #startSession(java.net.URL, Credentials)
+ * @see #startSession(String, int, String, int)
* @see #endSession()
*
*/
@@ -279,6 +306,12 @@
* @param url the {@link URL URL} from which the protocol, host,
* and port of the session are determined
*
+ * @see #startSession(java.net.URL)
+ * @see #startSession(String, int, boolean)
+ * @see #startSession(String, int)
+ * @see #startSession(String, int, Credentials)
+ * @see #startSession(String, int, Credentials, boolean)
+ * @see #startSession(String, int, String, int)
* @see #endSession()
*
*/
@@ -310,6 +343,7 @@
* Start an HTTP session with the server specified
* by the given <i>host</i> and <i>port</i>
* via the given <i>proxyhost</i> and <i>proxyport</i>.
+ *
* @param host the host to connect to
* @param port the port to connect to
* @param proxyhost the proxy host to connect via
@@ -328,12 +362,13 @@
* Execute the given {@link HttpMethod} using my current
* {@link HttpConnection connection} and {@link HttpState}.
*
- * @param method the {@link HttpMethod} to execute
+ * @param method the {@link HttpMethod} to execute. This parameter must be non-null.
* @return the method's response code
*
- * @throws IOException if an I/O error occurs
+ * @throws java.io.IOException if an I/O error occurs
* @throws HttpException if a protocol exception occurs
* @throws IllegalStateException if the session has not been started
+ *
*/
public synchronized int executeMethod(HttpMethod method)
throws IOException, HttpException, IllegalStateException {
@@ -370,7 +405,9 @@
* @see #startSession(java.net.URL)
* @see #startSession(java.net.URL, Credentials)
* @see #startSession(String, int, String, int)
- * @throws IOException when i/o errors occur closing the connection
+ *
+ * @throws java.io.IOException when i/o errors occur closing the connection
+ *
*/
public void endSession() throws IOException {
log.trace("enter HttpClient.endSession()");
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>