rwaldhoff 01/08/13 16:04:21
Modified: httpclient/src/java/org/apache/commons/httpclient Tag:
rlwrefactoring HttpMethod.java HttpMethodBase.java
Log:
Javadoc fixes.
Revision Changes Path
No revision
No revision
1.5.2.4 +9 -7
jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpMethod.java
Index: HttpMethod.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpMethod.java,v
retrieving revision 1.5.2.3
retrieving revision 1.5.2.4
diff -u -r1.5.2.3 -r1.5.2.4
--- HttpMethod.java 2001/08/13 22:37:12 1.5.2.3
+++ HttpMethod.java 2001/08/13 23:04:20 1.5.2.4
@@ -1,7 +1,7 @@
/*
- * $Header:
/home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpMethod.java,v
1.5.2.3 2001/08/13 22:37:12 rwaldhoff Exp $
- * $Revision: 1.5.2.3 $
- * $Date: 2001/08/13 22:37:12 $
+ * $Header:
/home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpMethod.java,v
1.5.2.4 2001/08/13 23:04:20 rwaldhoff Exp $
+ * $Revision: 1.5.2.4 $
+ * $Date: 2001/08/13 23:04:20 $
* ====================================================================
* Copyright (C) The Apache Software Foundation. All rights reserved.
*
@@ -43,7 +43,7 @@
// ------------------------------------------- Property Setters and Getters
/**
- * Obtain name of this method, suitable for use in the "request line",
+ * Obtain the name of this method, suitable for use in the "request line",
* for example <tt>GET</tt> or <tt>POST</tt>.
* @return the name of this method
*/
@@ -56,7 +56,7 @@
public void setPath(String path);
/**
- * Get the path part my request.
+ * Get the path part of my request.
* @return the path to request
*/
public String getPath();
@@ -197,9 +197,11 @@
* Execute this method.
*
* @param state state information to associate with this request
- * @param request the stream to write the request to
- * @param response the stream to read the response from
+ * @param connection the {@link HttpConnection} to write to/read from
* @param baseHeaders an intitial set of headers to use
+ *
+ * @throws IOException if an IO error occurs
+ * @throws HttpException
*
* @return the integer status code if one was obtained, or <tt>-1</tt>
*/
1.10.2.8 +15 -15
jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpMethodBase.java
Index: HttpMethodBase.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpMethodBase.java,v
retrieving revision 1.10.2.7
retrieving revision 1.10.2.8
diff -u -r1.10.2.7 -r1.10.2.8
--- HttpMethodBase.java 2001/08/13 22:37:12 1.10.2.7
+++ HttpMethodBase.java 2001/08/13 23:04:21 1.10.2.8
@@ -1,7 +1,7 @@
/*
- * $Header:
/home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpMethodBase.java,v
1.10.2.7 2001/08/13 22:37:12 rwaldhoff Exp $
- * $Revision: 1.10.2.7 $
- * $Date: 2001/08/13 22:37:12 $
+ * $Header:
/home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpMethodBase.java,v
1.10.2.8 2001/08/13 23:04:21 rwaldhoff Exp $
+ * $Revision: 1.10.2.8 $
+ * $Date: 2001/08/13 23:04:21 $
* ====================================================================
* Copyright (C) The Apache Software Foundation. All rights reserved.
*
@@ -44,7 +44,7 @@
*
* @author <a href="mailto:[EMAIL PROTECTED]";>Remy Maucherat</a>
* @author Rodney Waldhoff
- * @version $Id: HttpMethodBase.java,v 1.10.2.7 2001/08/13 22:37:12 rwaldhoff Exp $
+ * @version $Id: HttpMethodBase.java,v 1.10.2.8 2001/08/13 23:04:21 rwaldhoff Exp $
*/
public abstract class HttpMethodBase implements HttpMethod {
@@ -68,7 +68,7 @@
// ------------------------------------------- Property Setters and Getters
/**
- * Obtain name of this method, suitable for use in the "request line",
+ * Obtain the name of this method, suitable for use in the "request line",
* for example <tt>GET</tt> or <tt>POST</tt>.
* @return the name of this method
*/
@@ -83,7 +83,7 @@
}
/**
- * Get the path part my request.
+ * Get the path part of my request.
* @return the path to request
*/
public String getPath() {
@@ -295,18 +295,18 @@
// --------------------------------------------------------- Action Methods
+
/**
* Execute this method.
*
* @param state state information to associate with this request
- * @param request the stream to write the request to
- * @param response the stream to read the response from
+ * @param connection the {@link HttpConnection} to write to/read from
* @param baseHeaders an intitial set of headers to use
*
+ * @throws IOException if an IO error occurs
+ * @throws HttpException
+ *
* @return the integer status code if one was obtained, or <tt>-1</tt>
- * @throws HttpException if I have been used but not recycled
- * @throws HttpExcpetion if I am not {@link #validate valid}
- * @throws NullPointerException if <i>state</i> or <i>connection</i> is
<tt>null</tt>
*/
public int execute(State state, HttpConnection connection, Collection
baseHeaders) throws HttpException, IOException {
log.debug("HttpMethodBase.execute(State,HttpConnection,HashMap)");
@@ -553,9 +553,9 @@
* submitted to the given {@link HttpConnection}.
* <p>
* This implementation adds <tt>User-Agent</tt>,
- * <tt>Host</tt>, <tt>Cookie</tt>, <tt>Content-Length</tt>
+ * <tt>Host</tt>, <tt>Cookie</tt>, <tt>Content-Length</tt>,
* <tt>Transfer-Encoding</tt>, and <tt>Authorization</tt>
- * headers, where appropriate.
+ * headers, when appropriate.
* <p>
* Subclasses may want to override this method to
* to add additional headers, and may choose to
@@ -631,7 +631,7 @@
* Write the request body to the given {@link HttpConnection}
* <p>
* If an expectation is required, this method should
- * ensure that is has been sent by checking the
+ * ensure that it has been sent by checking the
* {@link #getStatusCode status code}.
* <p>
* This method should return <tt>true</tt>
@@ -640,7 +640,7 @@
* some reason (for example, expectation required but
* not present).
* <p>
- * This implementation always returns <tt>true</tt>.
+ * This implementation writes nothing and returns <tt>true</tt>.
* @return <tt>true</tt>
*/
protected boolean writeRequestBody(State state, HttpConnection conn) throws
IOException, HttpException {
