You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by js...@apache.org on 2002/10/16 18:58:26 UTC
cvs commit: jakarta-commons/httpclient/src/java/org/apache/commons/httpclient HttpMethodBase.java HttpMultiClient.java HttpStatus.java NameValuePair.java URI.java URIUtil.java
jsdever 2002/10/16 09:58:26
Modified: httpclient/src/java/org/apache/commons/httpclient
HttpMethodBase.java HttpMultiClient.java
HttpStatus.java NameValuePair.java URI.java
URIUtil.java
Log:
Fix javadoc warnings.
Contributed by: Justin Bedard
Revision Changes Path
1.65 +8 -7 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.64
retrieving revision 1.65
diff -u -r1.64 -r1.65
--- HttpMethodBase.java 15 Oct 2002 13:29:41 -0000 1.64
+++ HttpMethodBase.java 16 Oct 2002 16:58:26 -0000 1.65
@@ -287,7 +287,7 @@
}
/**
- * Set whether or not I should use the HTTP/1.1 protocol. internal
+ * Set whether or not I should use the HTTP/1.1 protocol.
*
* @param http11 true to use HTTP/1.1, false to use 1.0
*/
@@ -320,7 +320,8 @@
// ---------------------------------------------- Protected Utility Methods
/**
- * Return <tt>true</tt> if I should use the HTTP/1.1 protocol. internal
+ * Access to flag to determine if client should use
+ * HTTP/1.1 protocol.
*
* @return <tt>true</tt> if I should use the HTTP/1.1 protocol
*/
@@ -1748,7 +1749,7 @@
}
/**
- * Write the request body to the given {@link HttpConnection}
+ * Write the request body to the given {@link HttpConnection}.
*
* <p>
* If an expectation is required, this method should ensure that it has
1.17 +4 -4 jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpMultiClient.java
Index: HttpMultiClient.java
===================================================================
RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpMultiClient.java,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -r1.16 -r1.17
--- HttpMultiClient.java 23 Sep 2002 07:01:52 -0000 1.16
+++ HttpMultiClient.java 16 Oct 2002 16:58:26 -0000 1.17
@@ -219,7 +219,7 @@
* Returns the value of the request timeout.
*
* @return the request timeout
- * @see setRequestTimeout
+ * @see #setRequestTimeout(int)
*/
public int getRequestTimeout() {
return timeoutRequest;
1.9 +7 -4 jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpStatus.java
Index: HttpStatus.java
===================================================================
RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpStatus.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- HttpStatus.java 5 Sep 2002 04:48:15 -0000 1.8
+++ HttpStatus.java 16 Oct 2002 16:58:26 -0000 1.9
@@ -208,6 +208,7 @@
public static final int SC_EXPECTATION_FAILED = 417;
/**
+ * Static constant for a 418 error.
* <tt>418 Unprocessable Entity</tt> (WebDAV drafts?)
* or <tt>418 Reauthentication Required</tt> (HTTP/1.1 drafts?)
*/
@@ -215,6 +216,7 @@
// public static final int SC_UNPROCESSABLE_ENTITY = 418;
/**
+ * Static constant for a 419 error.
* <tt>419 Insufficient Space on Resource</tt>
* (WebDAV - draft-ietf-webdav-protocol-05?)
* or <tt>419 Proxy Reauthentication Required</tt>
@@ -222,6 +224,7 @@
*/
public static final int SC_INSUFFICIENT_SPACE_ON_RESOURCE = 419;
/**
+ * Static constant for a 420 error.
* <tt>420 Method Failure</tt>
* (WebDAV - draft-ietf-webdav-protocol-05?)
*/
1.10 +6 -6 jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/NameValuePair.java
Index: NameValuePair.java
===================================================================
RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/NameValuePair.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- NameValuePair.java 7 Sep 2002 16:45:48 -0000 1.9
+++ NameValuePair.java 16 Oct 2002 16:58:26 -0000 1.10
@@ -191,8 +191,8 @@
}
/**
- * Returns a hash code for this object such that
- * if <tt>a.{@link #equals equals}(b)</tt> then
+ * hashCode. Returns a hash code for this object such
+ * that if <tt>a.{@link #equals equals}(b)</tt> then
* <tt>a.hashCode() == b.hashCode()</tt>.
*/
public int hashCode() {
1.4 +66 -20 jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/URI.java
Index: URI.java
===================================================================
RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/URI.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- URI.java 9 Oct 2002 12:48:43 -0000 1.3
+++ URI.java 16 Oct 2002 16:58:26 -0000 1.4
@@ -605,6 +605,7 @@
/**
+ * BitSet for digit.
* <p><blockquote><pre>
* digit = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" |
* "8" | "9"
@@ -620,6 +621,7 @@
/**
+ * BitSet for alpha.
* <p><blockquote><pre>
* alpha = lowalpha | upalpha
* </pre></blockquote><p>
@@ -637,6 +639,7 @@
/**
+ * BitSet for alphanum (join of alpha & digit).
* <p><blockquote><pre>
* alphanum = alpha | digit
* </pre></blockquote><p>
@@ -650,6 +653,7 @@
/**
+ * BitSet for hex.
* <p><blockquote><pre>
* hex = digit | "A" | "B" | "C" | "D" | "E" | "F" |
* "a" | "b" | "c" | "d" | "e" | "f"
@@ -669,6 +673,7 @@
/**
+ * BitSet for escaped.
* <p><blockquote><pre>
* escaped = "%" hex hex
* </pre></blockquote><p>
@@ -682,6 +687,7 @@
/**
+ * BitSet for mark.
* <p><blockquote><pre>
* mark = "-" | "_" | "." | "!" | "~" | "*" | "'" |
* "(" | ")"
@@ -718,8 +724,9 @@
/**
+ * BitSet for reserved.
* <p><blockquote><pre>
- * reserved = ";" | "/" | "?" | ":" | "@" | "&" | "=" | "+" |
+ * reserved = ";" | "/" | "?" | ":" | "@" | "&" | "=" | "+" |
* "$" | ","
* </pre></blockquote><p>
*/
@@ -740,6 +747,7 @@
/**
+ * BitSet for uric.
* <p><blockquote><pre>
* uric = reserved | unreserved | escaped
* </pre></blockquote><p>
@@ -754,6 +762,7 @@
/**
+ * BitSet for fragment (alias for uric).
* <p><blockquote><pre>
* fragment = *uric
* </pre></blockquote><p>
@@ -762,6 +771,7 @@
/**
+ * BitSet for query (alias for uric).
* <p><blockquote><pre>
* query = *uric
* </pre></blockquote><p>
@@ -770,6 +780,7 @@
/**
+ * BitSet for pchar.
* <p><blockquote><pre>
* pchar = unreserved | escaped |
* ":" | "@" | "&" | "=" | "+" | "$" | ","
@@ -791,6 +802,7 @@
/**
+ * BitSet for param (alias for pchar).
* <p><blockquote><pre>
* param = *pchar
* </pre></blockquote><p>
@@ -799,6 +811,7 @@
/**
+ * BitSet for segment.
* <p><blockquote><pre>
* segment = *pchar *( ";" param )
* </pre></blockquote><p>
@@ -813,6 +826,7 @@
/**
+ * BitSet for path segments.
* <p><blockquote><pre>
* path_segments = segment *( "/" segment )
* </pre></blockquote><p>
@@ -826,9 +840,10 @@
/**
+ * URI absolute path.
* <p><blockquote><pre>
* abs_path = "/" path_segments
- * </pre></blockquote><p>
+ * </pre><blockquote><p>
*/
protected static final BitSet abs_path = new BitSet(256);
// Static initializer for abs_path
@@ -839,9 +854,10 @@
/**
+ * URI bitset for encoding typical non-slash characters.
* <p><blockquote><pre>
* uric_no_slash = unreserved | escaped | ";" | "?" | ":" | "@" |
- * "&" | "=" | "+" | "$" | ","
+ * "&" | "=" | "+" | "$" | ","
* </pre></blockquote><p>
*/
protected static final BitSet uric_no_slash = new BitSet(256);
@@ -862,6 +878,7 @@
/**
+ * URI bitset that combines uric_no_slash and uric.
* <p><blockquote><pre>
* opaque_part = uric_no_slash *uric
* </pre></blockquote><p>
@@ -875,6 +892,7 @@
/**
+ * URI bitset that combines absolute path and opaque part.
* <p><blockquote><pre>
* path = [ abs_path | opaque_part ]
* </pre></blockquote><p>
@@ -888,12 +906,13 @@
/**
- * port
+ * Port, a logical alias for digit.
*/
protected static final BitSet port = digit;
/**
+ * Bitset that combines digit and dot fo IPv$address.
* <p><blockquote><pre>
* IPv4address = 1*digit "." 1*digit "." 1*digit "." 1*digit
* </pre></blockquote><p>
@@ -907,7 +926,7 @@
/**
- * RFC 2373
+ * RFC 2373.
* <p><blockquote><pre>
* IPv6address = hexpart [ ":" IPv4address ]
* </pre></blockquote><p>
@@ -922,7 +941,7 @@
/**
- * RFC 2732, 2373
+ * RFC 2732, 2373.
* <p><blockquote><pre>
* IPv6reference = "[" IPv6address "]"
* </pre></blockquote><p>
@@ -937,6 +956,7 @@
/**
+ * BitSet for toplabel.
* <p><blockquote><pre>
* toplabel = alpha | alpha *( alphanum | "-" ) alphanum
* </pre></blockquote><p>
@@ -950,6 +970,7 @@
/**
+ * BitSet for domainlabel.
* <p><blockquote><pre>
* domainlabel = alphanum | alphanum *( alphanum | "-" ) alphanum
* </pre></blockquote><p>
@@ -958,6 +979,7 @@
/**
+ * BitSet for hostname.
* <p><blockquote><pre>
* hostname = *( domainlabel "." ) toplabel [ "." ]
* </pre></blockquote><p>
@@ -972,6 +994,7 @@
/**
+ * BitSet for host.
* <p><blockquote><pre>
* host = hostname | IPv4address | IPv6reference
* </pre></blockquote><p>
@@ -986,6 +1009,7 @@
/**
+ * BitSet for hostport.
* <p><blockquote><pre>
* hostport = host [ ":" port ]
* </pre></blockquote><p>
@@ -1000,9 +1024,10 @@
/**
+ * Bitset for userinfo.
* <p><blockquote><pre>
* userinfo = *( unreserved | escaped |
- * ";" | ":" | "&" | "=" | "+" | "$" | "," )
+ * ";" | ":" | "&" | "=" | "+" | "$" | "," )
* </pre></blockquote><p>
*/
protected static final BitSet userinfo = new BitSet(256);
@@ -1021,6 +1046,7 @@
/**
+ * Bitset for server.
* <p><blockquote><pre>
* server = [ [ userinfo "@" ] hostport ]
* </pre></blockquote><p>
@@ -1035,9 +1061,10 @@
/**
+ * BitSet for reg_name.
* <p><blockquote><pre>
* reg_name = 1*( unreserved | escaped | "$" | "," |
- * ";" | ":" | "@" | "&" | "=" | "+" )
+ * ";" | ":" | "@" | "&" | "=" | "+" )
* </pre></blockquote><p>
*/
protected static final BitSet reg_name = new BitSet(256);
@@ -1057,6 +1084,7 @@
/**
+ * BitSet for authority.
* <p><blockquote><pre>
* authority = server | reg_name
* </pre></blockquote><p>
@@ -1070,6 +1098,7 @@
/**
+ * BitSet for scheme.
* <p><blockquote><pre>
* scheme = alpha *( alpha | digit | "+" | "-" | "." )
* </pre></blockquote><p>
@@ -1086,6 +1115,7 @@
/**
+ * BitSet for rel_segment.
* <p><blockquote><pre>
* rel_segment = 1*( unreserved | escaped |
* ";" | "@" | "&" | "=" | "+" | "$" | "," )
@@ -1107,6 +1137,7 @@
/**
+ * BitSet for rel_path.
* <p><blockquote><pre>
* rel_path = rel_segment [ abs_path ]
* </pre></blockquote><p>
@@ -1120,6 +1151,7 @@
/**
+ * BitSet for net_path.
* <p><blockquote><pre>
* net_path = "//" authority [ abs_path ]
* </pre></blockquote><p>
@@ -1134,6 +1166,7 @@
/**
+ * BitSet for hier_part.
* <p><blockquote><pre>
* hier_part = ( net_path | abs_path ) [ "?" query ]
* </pre></blockquote><p>
@@ -1149,6 +1182,7 @@
/**
+ * BitSet for relativeURI.
* <p><blockquote><pre>
* relativeURI = ( net_path | abs_path | rel_path ) [ "?" query ]
* </pre></blockquote><p>
@@ -1165,6 +1199,7 @@
/**
+ * BitSet for absoluteURI.
* <p><blockquote><pre>
* absoluteURI = scheme ":" ( hier_part | opaque_part )
* </pre></blockquote><p>
@@ -1180,6 +1215,7 @@
/**
+ * BitSet for URI-reference.
* <p><blockquote><pre>
* URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]
* </pre></blockquote><p>
@@ -1197,7 +1233,7 @@
// Excluded US-ASCII Characters are like control, space, delims and unwise
/**
- * control
+ * BitSet for control.
*/
public static final BitSet control = new BitSet(256);
// Static initializer for control
@@ -1209,7 +1245,7 @@
}
/**
- * space
+ * BitSet for space.
*/
public static final BitSet space = new BitSet(256);
// Static initializer for space
@@ -1219,7 +1255,7 @@
/**
- * delims
+ * BitSet for delims.
*/
public static final BitSet delims = new BitSet(256);
// Static initializer for delims
@@ -1233,7 +1269,7 @@
/**
- * unwise
+ * BitSet for unwise.
*/
public static final BitSet unwise = new BitSet(256);
// Static initializer for unwise
@@ -1250,7 +1286,7 @@
/**
- * disallowed rel_path before escaping
+ * Disallowed rel_path before escaping.
*/
public static final BitSet disallowed_rel_path = new BitSet(256);
// Static initializer for disallowed_rel_path
@@ -1261,7 +1297,7 @@
/**
- * disallowed opaque_part before escaping
+ * Disallowed opaque_part before escaping.
*/
public static final BitSet disallowed_opaque_part = new BitSet(256);
// Static initializer for disallowed_opaque_part
@@ -1320,7 +1356,7 @@
/**
* Those characters that are allowed within the IPv6reference component.
- * '[', ']' in IPv6reference should be excluded.
+ * The characters '[', ']' in IPv6reference should be excluded.
*/
public static final BitSet allowed_IPv6reference = new BitSet(256);
// Static initializer for allowed_IPv6reference
@@ -1334,7 +1370,7 @@
/**
* Those characters that are allowed within the host component.
- * '[', ']' in IPv6reference should be excluded.
+ * The characters '[', ']' in IPv6reference should be excluded.
*/
public static final BitSet allowed_host = new BitSet(256);
// Static initializer for allowed_host
@@ -1427,6 +1463,8 @@
/**
+ * Encodes URI string.
+ *
* This is a two mapping, one from original characters to octets, and
* subsequently a second from octets to URI characters:
* <p><blockquote><pre>
@@ -1510,6 +1548,8 @@
/**
+ * Decodes URI encoded string.
+ *
* This is a two mapping, one from URI characters to octets, and
* subsequently a second from octets to original characters:
* <p><blockquote><pre>
@@ -1706,6 +1746,7 @@
}
/**
+ * Find @ symbol.
* <p><blockquote><pre>
* @@@@@@@@
* ^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))?
@@ -1721,6 +1762,7 @@
int length = tmp.length();
/**
+ * Find scheme.
* <p><blockquote><pre>
* scheme = $2 = http
* @
@@ -1738,6 +1780,7 @@
}
/**
+ * Find authority.
* <p><blockquote><pre>
* authority = $4 = jakarta.apache.org
* @@
@@ -1768,6 +1811,7 @@
}
/**
+ * Find path.
* <p><blockquote><pre>
* path = $5 = /ietf/uri/
* @@@@@@
@@ -1803,6 +1847,7 @@
}
/**
+ * Find query.
* <p><blockquote><pre>
* query = $7 = <undefined>
* @@@@@@@@@
@@ -1820,6 +1865,7 @@
}
/**
+ * Find fragment.
* <p><blockquote><pre>
* fragment = $9 = Related
* @@@@@@@@
1.14 +9 -9 jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/URIUtil.java
Index: URIUtil.java
===================================================================
RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/URIUtil.java,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- URIUtil.java 10 Oct 2002 04:01:52 -0000 1.13
+++ URIUtil.java 16 Oct 2002 16:58:26 -0000 1.14
@@ -69,10 +69,7 @@
import java.util.BitSet;
/**
- * <p>
- * General purpose methods for encoding URI's, as described in
- * <a href="http://www.ietf.org/rfc/rfc2396.txt?number=2396">RFC 2396</a>.
- * </p>
+ * General purpose methods for encoding URIs.
* <p>
* This class provides a number of methods useful for encoding and
* decoding the "%HH" format, as used in various HTTP related
@@ -82,7 +79,10 @@
* of the core JDK {@link java.net.URLEncoder} and
* {@link java.net.URLDecoder} classes.
* </p>
- * <p>As well this class provides some useful methods for dealing with URLs</p>
+ * This class is in accordance with
+ * <a href="http://www.ietf.org/rfc/rfc2396.txt">RFC 2396</a>.
+ * As well this class provides some useful methods for dealing with URLs
+ * </p>
*
* @author Craig R. McClanahan
* @author Tim Tye
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>