rwaldhoff 01/08/13 08:54:31
Modified: httpclient/src/java/org/apache/commons/httpclient Tag:
rlwrefactoring HttpMethod.java
Log:
additional comments
Revision Changes Path
No revision
No revision
1.5.2.2 +59 -16
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.1
retrieving revision 1.5.2.2
diff -u -r1.5.2.1 -r1.5.2.2
--- HttpMethod.java 2001/08/10 22:27:12 1.5.2.1
+++ HttpMethod.java 2001/08/13 15:54:31 1.5.2.2
@@ -1,7 +1,7 @@
/*
- * $Header:
/home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpMethod.java,v
1.5.2.1 2001/08/10 22:27:12 rwaldhoff Exp $
- * $Revision: 1.5.2.1 $
- * $Date: 2001/08/10 22:27:12 $
+ * $Header:
/home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpMethod.java,v
1.5.2.2 2001/08/13 15:54:31 rwaldhoff Exp $
+ * $Revision: 1.5.2.2 $
+ * $Date: 2001/08/13 15:54:31 $
* ====================================================================
* Copyright (C) The Apache Software Foundation. All rights reserved.
*
@@ -41,13 +41,13 @@
public String getName();
/**
- * Set the path part of this method's request.
+ * Set the path part of my request.
* @param path the path to request
*/
public void setPath(String path);
/**
- * Set the path part of this method's request.
+ * Get the path part my request.
* @return the path to request
*/
public String getPath();
@@ -69,7 +69,7 @@
/**
* Get the request header associated with the given name.
- * Header-name matching is case insensitive.
+ * Note that header-name matching is case insensitive.
* @param headerName the header name
* @return the header
*/
@@ -77,14 +77,14 @@
/**
* Remove the request header associated with the given name.
- * Header-name matching is case insensitive.
+ * Note that header-name matching is case insensitive.
* @param headerName the header name
* @return the header
*/
public void removeRequestHeader(String headerName);
/**
- * Whether or not this method should automatically follow
+ * Whether or not I should automatically follow
* HTTP redirects (status code 302, etc.)
*/
public boolean followRedirects();
@@ -97,36 +97,65 @@
/**
* Set the specified request (query string) parameter,
- * overriding any previous value.
+ * overwriting any previous value associated with the
+ * given <i>parameterName</i>.
+ *
+ * @param parameterName the name of the parameter, which MUST NOT
+ * be <tt>null</tt>
+ * @param parameterValue the name of the parameter, which MAY
+ * be <tt>null</tt>
*/
public void setParameter(String parameterName, String parameterValue);
/**
- * Add the specified request (query string) parameter,
- * NOT overriding any previous value.
+ * Set the specified request (query string) parameter,
+ * NOT overwriting any previous value associated with
+ * the given <i>parameterName</i>.
+ *
+ * @param parameterName the name of the parameter, which MUST NOT
+ * be <tt>null</tt>
+ * @param parameterValue the name of the parameter, which MAY
+ * be <tt>null</tt>
*/
public void addParameter(String parameterName, String parameterValue);
+ /**
+ * Remove all request parameters associated with
+ * the given <i>parameterName</i>.
+ *
+ * @param parameterName the name of the parameter, which MUST NOT
+ * be <tt>null</tt>
+ */
public void removeParameter(String parameterName);
+
+ /**
+ * Remove a single instance of the specified name-value pair
+ * from my request parameters
+ *
+ * @param parameterName the name of the parameter, which MUST NOT
+ * be <tt>null</tt>
+ * @param parameterValue the name of the parameter, which MAY
+ * be <tt>null</tt>
+ */
public void removeParameter(String parameterName, String parameterValue);
/**
- * Set the query string.
+ * Set my query string.
*/
public void setQueryString(String queryString);
/**
- * Return an iterator over the request headers.
+ * Return an iterator over my headers.
*/
public Iterator getRequestHeaders();
/**
- * Confirm that this method is ready to execute.
+ * Confirm that I am ready to execute.
*/
public boolean validate();
/**
- * Execute the method.
+ * 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
@@ -145,10 +174,24 @@
public String getStatusText();
/**
- * Return an interator over the response headers.
+ * Return an interator over my response headers.
*/
public Iterator getResponseHeaders();
+
+ /**
+ * Return the specified response headers.
+ */
public Header getResponseHeader(String headerName);
+
+ /**
+ * Return <tt>true</tt> if I have been used but not
+ * recycled.
+ */
public boolean hasBeenUsed();
+
+ /**
+ * Recycle this method so that it can be used again.
+ * This method clears my path and query string.
+ */
public void recycle();
}
