hc-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ol...@apache.org
Subject svn commit: r728464 - in /httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http: ./ message/
Date Sun, 21 Dec 2008 17:59:06 GMT
Author: olegk
Date: Sun Dec 21 09:59:05 2008
New Revision: 728464

URL: http://svn.apache.org/viewvc?rev=728464&view=rev
Log:
Javadoc updates

Modified:
    httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HeaderElement.java
    httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/AbstractHttpMessage.java
    httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicHeader.java
    httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicHeaderElement.java
    httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicHeaderValueFormatter.java
    httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicHeaderValueParser.java
    httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicHttpEntityEnclosingRequest.java
    httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicHttpRequest.java
    httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicHttpResponse.java
    httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicLineFormatter.java
    httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicLineParser.java
    httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicListHeaderIterator.java
    httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicNameValuePair.java
    httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicRequestLine.java
    httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicStatusLine.java
    httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/HeaderValueFormatter.java
    httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/HeaderValueParser.java
    httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/LineFormatter.java
    httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/LineParser.java

Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HeaderElement.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HeaderElement.java?rev=728464&r1=728463&r2=728464&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HeaderElement.java
(original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HeaderElement.java
Sun Dec 21 09:59:05 2008
@@ -32,9 +32,32 @@
 package org.apache.http;
 
 /**
- * One element of an HTTP {@link Header header} value. Header element
- * is a name / value pair with a number of optional name / value 
- * parameters.
+ * One element of an HTTP {@link Header header} value consisting of 
+ * a name / value pair and a number of optional name / value parameters.
+ * <p>
+ * Some HTTP headers (such as the set-cookie header) have values that
+ * can be decomposed into multiple elements.  Such headers must be in the
+ * following form:
+ * </p>
+ * <pre>
+ * header  = [ element ] *( "," [ element ] )
+ * element = name [ "=" [ value ] ] *( ";" [ param ] )
+ * param   = name [ "=" [ value ] ]
+ *
+ * name    = token
+ * value   = ( token | quoted-string )
+ *
+ * token         = 1*&lt;any char except "=", ",", ";", &lt;"&gt; and
+ *                       white space&gt;
+ * quoted-string = &lt;"&gt; *( text | quoted-char ) &lt;"&gt;
+ * text          = any char except &lt;"&gt;
+ * quoted-char   = "\" char
+ * </pre>
+ * <p>
+ * Any amount of white space is allowed between any part of the
+ * header, element or param and is ignored. A missing value in any
+ * element or param will be stored as the empty {@link String};
+ * if the "=" is also missing <var>null</var> will be stored instead.
  *
  * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
  *

Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/AbstractHttpMessage.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/AbstractHttpMessage.java?rev=728464&r1=728463&r2=728464&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/AbstractHttpMessage.java
(original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/AbstractHttpMessage.java
Sun Dec 21 09:59:05 2008
@@ -40,7 +40,7 @@
 import org.apache.http.params.BasicHttpParams;
 
 /**
- * Basic implementation of an HTTP message that can be modified.
+ * Basic implementation of {@link HttpMessage}.
  *
  * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
  *

Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicHeader.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicHeader.java?rev=728464&r1=728463&r2=728464&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicHeader.java
(original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicHeader.java
Sun Dec 21 09:59:05 2008
@@ -36,43 +36,16 @@
 import org.apache.http.ParseException;
 
 /**
- * Represents an HTTP header field.
  * 
- * <p>The HTTP header fields follow the same generic format as
- * that given in Section 3.1 of RFC 822. Each header field consists
- * of a name followed by a colon (":") and the field value. Field names
- * are case-insensitive. The field value MAY be preceded by any amount
- * of LWS, though a single SP is preferred. 
- *
- *<pre>
- *     message-header = field-name ":" [ field-value ]
- *     field-name     = token
- *     field-value    = *( field-content | LWS )
- *     field-content  = &lt;the OCTETs making up the field-value
- *                      and consisting of either *TEXT or combinations
- *                      of token, separators, and quoted-string&gt;
- *</pre>
+ * Basic implementation of {@link Header}.
  * 
- * @author <a href="mailto:remm@apache.org">Remy Maucherat</a>
- * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
- * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
- *
- *
- * <!-- empty lines above to avoid 'svn diff' context problems -->
- * @version $Revision$ $Date$
+ * @version $Revision$
  * 
  * @since 4.0
  */
 public class BasicHeader implements Header, Cloneable {
 
-    /**
-     * Header name.
-     */
     private final String name;
-    
-    /**
-     * Header value.
-     */
     private final String value;
     
     /**
@@ -90,43 +63,19 @@
         this.value = value;
     }
 
-    /**
-     * Returns the header name.
-     *
-     * @return String name The name
-     */
     public String getName() {
         return this.name;
     }
 
-    /**
-     * Returns the header value.
-     *
-     * @return String value The current value.
-     */
     public String getValue() {
         return this.value;
     }
 
-    /**
-     * Returns a {@link String} representation of the header.
-     *
-     * @return a string
-     */
     public String toString() {
         // no need for non-default formatting in toString()
         return BasicLineFormatter.DEFAULT.formatHeader(null, this).toString();
     }
 
-    /**
-     * Returns an array of {@link HeaderElement}s constructed from my value.
-     *
-     * @see BasicHeaderValueParser#parseElements(String, HeaderValueParser)
-     * 
-     * @return an array of header elements
-     *
-     * @throws ParseException   in case of a parse error
-     */
     public HeaderElement[] getElements() throws ParseException {
         if (this.value != null) {
             // result intentionally not cached, it's probably not used again

Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicHeaderElement.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicHeaderElement.java?rev=728464&r1=728463&r2=728464&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicHeaderElement.java
(original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicHeaderElement.java
Sun Dec 21 09:59:05 2008
@@ -37,46 +37,9 @@
 import org.apache.http.util.LangUtils;
 
 /**
- * One element of an HTTP header's value.
- * <p>
- * Some HTTP headers (such as the set-cookie header) have values that
- * can be decomposed into multiple elements.  Such headers must be in the
- * following form:
- * </p>
- * <pre>
- * header  = [ element ] *( "," [ element ] )
- * element = name [ "=" [ value ] ] *( ";" [ param ] )
- * param   = name [ "=" [ value ] ]
- *
- * name    = token
- * value   = ( token | quoted-string )
- *
- * token         = 1*&lt;any char except "=", ",", ";", &lt;"&gt; and
- *                       white space&gt;
- * quoted-string = &lt;"&gt; *( text | quoted-char ) &lt;"&gt;
- * text          = any char except &lt;"&gt;
- * quoted-char   = "\" char
- * </pre>
- * <p>
- * Any amount of white space is allowed between any part of the
- * header, element or param and is ignored. A missing value in any
- * element or param will be stored as the empty {@link String};
- * if the "=" is also missing <var>null</var> will be stored instead.
- * </p>
- * <p>
- * This class represents an individual header element, containing
- * both a name/value pair (value may be <tt>null</tt>) and optionally
- * a set of additional parameters.
- * </p>
- *
- * @author <a href="mailto:bcholmes@interlog.com">B.C. Holmes</a>
- * @author <a href="mailto:jericho@thinkfree.com">Park, Sung-Gu</a>
- * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
- * @author <a href="mailto:oleg at ural.com">Oleg Kalnichevski</a>
- *
- *
- * <!-- empty lines above to avoid 'svn diff' context problems -->
- * @version $Revision$ $Date$
+ * Basic implementation of {@link HeaderElement}
+ * 
+ * @version $Revision$
  * 
  * @since 4.0
  */
@@ -121,66 +84,27 @@
        this(name, value, null);
     }
 
-    /**
-     * Returns the name.
-     *
-     * @return String name The name
-     */
     public String getName() {
         return this.name;
     }
 
-    /**
-     * Returns the value.
-     *
-     * @return String value The current value.
-     */
     public String getValue() {
         return this.value;
     }
 
-    /**
-     * Get parameters, if any.
-     * The returned array is created for each invocation and can
-     * be modified by the caller without affecting this header element.
-     *
-     * @return parameters as an array of {@link NameValuePair}s
-     */
     public NameValuePair[] getParameters() {
         return (NameValuePair[])this.parameters.clone();
     }
 
-
-    /**
-     * Obtains the number of parameters.
-     *
-     * @return  the number of parameters
-     */
     public int getParameterCount() {
         return this.parameters.length;
     }
 
-
-    /**
-     * Obtains the parameter with the given index.
-     *
-     * @param index     the index of the parameter, 0-based
-     *
-     * @return  the parameter with the given index
-     */
     public NameValuePair getParameter(int index) {
         // ArrayIndexOutOfBoundsException is appropriate
         return this.parameters[index];
     }
 
-
-    /**
-     * Returns parameter with the given name, if found. Otherwise null 
-     * is returned
-     *
-     * @param name The name to search by.
-     * @return NameValuePair parameter with the given name
-     */
     public NameValuePair getParameterByName(final String name) {
         if (name == null) {
             throw new IllegalArgumentException("Name may not be null");

Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicHeaderValueFormatter.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicHeaderValueFormatter.java?rev=728464&r1=728463&r2=728464&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicHeaderValueFormatter.java
(original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicHeaderValueFormatter.java
Sun Dec 21 09:59:05 2008
@@ -35,7 +35,6 @@
 import org.apache.http.NameValuePair;
 import org.apache.http.util.CharArrayBuffer;
 
-
 /**
  * Basic implementation for formatting header value elements.
  * Instances of this class are stateless and thread-safe.

Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicHeaderValueParser.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicHeaderValueParser.java?rev=728464&r1=728463&r2=728464&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicHeaderValueParser.java
(original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicHeaderValueParser.java
Sun Dec 21 09:59:05 2008
@@ -31,7 +31,6 @@
 
 package org.apache.http.message;
 
-
 import java.util.List;
 import java.util.ArrayList;
 
@@ -41,8 +40,6 @@
 import org.apache.http.protocol.HTTP;
 import org.apache.http.util.CharArrayBuffer;
 
-
-
 /**
  * Basic implementation for parsing header values into elements.
  * Instances of this class are stateless and thread-safe.

Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicHttpEntityEnclosingRequest.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicHttpEntityEnclosingRequest.java?rev=728464&r1=728463&r2=728464&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicHttpEntityEnclosingRequest.java
(original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicHttpEntityEnclosingRequest.java
Sun Dec 21 09:59:05 2008
@@ -39,9 +39,7 @@
 import org.apache.http.protocol.HTTP;
 
 /**
- * Basic implementation of a request with an entity that can be modified.
- *
- * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
+ * Basic implementation of {@link HttpEntityEnclosingRequest}.
  *
  * @version $Revision$
  * 

Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicHttpRequest.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicHttpRequest.java?rev=728464&r1=728463&r2=728464&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicHttpRequest.java
(original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicHttpRequest.java
Sun Dec 21 09:59:05 2008
@@ -37,9 +37,7 @@
 import org.apache.http.params.HttpProtocolParams;
 
 /**
- * Basic implementation of an HTTP request that can be modified.
- *
- * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
+ * Basic implementation of {@link HttpRequest}.
  *
  * @version $Revision$
  * 

Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicHttpResponse.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicHttpResponse.java?rev=728464&r1=728463&r2=728464&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicHttpResponse.java
(original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicHttpResponse.java
Sun Dec 21 09:59:05 2008
@@ -41,10 +41,7 @@
 
 
 /**
- * Basic implementation of an HTTP response that can be modified.
- * This implementation makes sure that there always is a status line.
- *
- * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
+ * Basic implementation of {@link HttpResponse}.
  *
  * @version $Revision$
  * 

Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicLineFormatter.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicLineFormatter.java?rev=728464&r1=728463&r2=728464&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicLineFormatter.java
(original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicLineFormatter.java
Sun Dec 21 09:59:05 2008
@@ -31,7 +31,6 @@
 
 package org.apache.http.message;
 
-
 import org.apache.http.ProtocolVersion;
 import org.apache.http.RequestLine;
 import org.apache.http.StatusLine;
@@ -39,7 +38,6 @@
 import org.apache.http.FormattedHeader;
 import org.apache.http.util.CharArrayBuffer;
 
-
 /**
  * Interface for formatting elements of the HEAD section of an HTTP message.
  * This is the complement to {@link LineParser}.

Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicLineParser.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicLineParser.java?rev=728464&r1=728463&r2=728464&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicLineParser.java
(original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicLineParser.java
Sun Dec 21 09:59:05 2008
@@ -40,7 +40,6 @@
 import org.apache.http.protocol.HTTP;
 import org.apache.http.util.CharArrayBuffer;
 
-
 /**
  * Basic parser for lines in the head section of an HTTP message.
  * There are individual methods for parsing a request line, a
@@ -103,7 +102,6 @@
     }
 
 
-
     public final static
         ProtocolVersion parseProtocolVersion(String value,
                                              LineParser parser)

Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicListHeaderIterator.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicListHeaderIterator.java?rev=728464&r1=728463&r2=728464&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicListHeaderIterator.java
(original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicListHeaderIterator.java
Sun Dec 21 09:59:05 2008
@@ -31,14 +31,12 @@
 
 package org.apache.http.message;
 
-
 import java.util.List;
 import java.util.NoSuchElementException;
 
 import org.apache.http.Header;
 import org.apache.http.HeaderIterator;
 
-
 /**
  * Implementation of a {@link HeaderIterator} based on a {@link List}.
  * For use by {@link HeaderGroup}.

Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicNameValuePair.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicNameValuePair.java?rev=728464&r1=728463&r2=728464&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicNameValuePair.java
(original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicNameValuePair.java
Sun Dec 21 09:59:05 2008
@@ -38,72 +38,7 @@
 import org.apache.http.util.LangUtils;
 
 /**
- * A simple class encapsulating an attribute/value pair.
- * <p>
- *  This class comforms to the generic grammar and formatting rules outlined in the 
- *  <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec2.html#sec2.2">Section
2.2</a>
- *  and  
- *  <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.6">Section
3.6</a>
- *  of <a href="http://www.w3.org/Protocols/rfc2616/rfc2616.txt">RFC 2616</a>
- * </p>
- * <h>2.2 Basic Rules</h>
- * <p>
- *  The following rules are used throughout this specification to describe basic parsing
constructs. 
- *  The US-ASCII coded character set is defined by ANSI X3.4-1986.
- * </p>
- * <pre>
- *     OCTET          = <any 8-bit sequence of data>
- *     CHAR           = <any US-ASCII character (octets 0 - 127)>
- *     UPALPHA        = <any US-ASCII uppercase letter "A".."Z">
- *     LOALPHA        = <any US-ASCII lowercase letter "a".."z">
- *     ALPHA          = UPALPHA | LOALPHA
- *     DIGIT          = <any US-ASCII digit "0".."9">
- *     CTL            = <any US-ASCII control character
- *                      (octets 0 - 31) and DEL (127)>
- *     CR             = <US-ASCII CR, carriage return (13)>
- *     LF             = <US-ASCII LF, linefeed (10)>
- *     SP             = <US-ASCII SP, space (32)>
- *     HT             = <US-ASCII HT, horizontal-tab (9)>
- *     <">            = <US-ASCII double-quote mark (34)>
- * </pre>
- * <p>
- *  Many HTTP/1.1 header field values consist of words separated by LWS or special 
- *  characters. These special characters MUST be in a quoted string to be used within 
- *  a parameter value (as defined in section 3.6).
- * <p>
- * <pre>
- * token          = 1*<any CHAR except CTLs or separators>
- * separators     = "(" | ")" | "<" | ">" | "@"
- *                | "," | ";" | ":" | "\" | <">
- *                | "/" | "[" | "]" | "?" | "="
- *                | "{" | "}" | SP | HT
- * </pre>
- * <p>
- *  A string of text is parsed as a single word if it is quoted using double-quote marks.
- * </p>
- * <pre>
- * quoted-string  = ( <"> *(qdtext | quoted-pair ) <"> )
- * qdtext         = <any TEXT except <">>
- * </pre>
- * <p>
- *  The backslash character ("\") MAY be used as a single-character quoting mechanism only

- *  within quoted-string and comment constructs.
- * </p>
- * <pre>
- * quoted-pair    = "\" CHAR
- * </pre>
- * <h>3.6 Transfer Codings</h>
- * <p>
- *  Parameters are in the form of attribute/value pairs.
- * </p>
- * <pre>
- * parameter               = attribute "=" value
- * attribute               = token
- * value                   = token | quoted-string
- * </pre> 
- * 
- * @author <a href="mailto:oleg at ural.com">Oleg Kalnichevski</a>
- * 
+ * Basic implementation of {@link NameValuePair}.
  */
 public class BasicNameValuePair implements NameValuePair, Cloneable, Serializable {
 
@@ -127,30 +62,14 @@
         this.value = value;
     }
 
-    /**
-     * Returns the name.
-     *
-     * @return String name The name
-     */
     public String getName() {
         return this.name;
     }
 
-    /**
-     * Returns the value.
-     *
-     * @return String value The current value.
-     */
     public String getValue() {
         return this.value;
     }
 
-    
-    /**
-     * Get a string representation of this pair.
-     * 
-     * @return A string representation.
-     */
     public String toString() {
         // don't call complex default formatting for a simple toString
     	

Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicRequestLine.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicRequestLine.java?rev=728464&r1=728463&r2=728464&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicRequestLine.java
(original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicRequestLine.java
Sun Dec 21 09:59:05 2008
@@ -35,12 +35,7 @@
 import org.apache.http.RequestLine;
 
 /**
- * The first line of an {@link org.apache.http.HttpRequest HttpRequest}.
- * It contains the method, URI, and HTTP version of the request.
- * For details, see RFC 2616.
- *
- * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
- *
+ * Basic implementation of {@link RequestLine}.
  *
  * <!-- empty lines above to avoid 'svn diff' context problems -->
  * @version $Revision$

Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicStatusLine.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicStatusLine.java?rev=728464&r1=728463&r2=728464&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicStatusLine.java
(original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/BasicStatusLine.java
Sun Dec 21 09:59:05 2008
@@ -31,20 +31,11 @@
 
 package org.apache.http.message;
 
-import org.apache.http.HttpStatus;
 import org.apache.http.ProtocolVersion;
 import org.apache.http.StatusLine;
 
-
-
 /**
- * Represents a status line as returned from a HTTP server.
- * See <a href="http://www.ietf.org/rfc/rfc2616.txt">RFC2616</a> section 6.1.
- * This class is immutable and therefore inherently thread safe.
- *
- * @see HttpStatus
- * @author <a href="mailto:jsdever@apache.org">Jeff Dever</a>
- * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
+ * Basic implementation of {@link StatusLine}
  *
  * @version $Id$
  * 
@@ -90,23 +81,14 @@
 
     // --------------------------------------------------------- Public Methods
 
-    /**
-     * @return the Status-Code
-     */
     public int getStatusCode() {
         return this.statusCode;
     }
 
-    /**
-     * @return the HTTP-Version
-     */
     public ProtocolVersion getProtocolVersion() {
         return this.protoVersion;
     }
 
-    /**
-     * @return the Reason-Phrase
-     */
     public String getReasonPhrase() {
         return this.reasonPhrase;
     }

Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/HeaderValueFormatter.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/HeaderValueFormatter.java?rev=728464&r1=728463&r2=728464&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/HeaderValueFormatter.java
(original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/HeaderValueFormatter.java
Sun Dec 21 09:59:05 2008
@@ -31,13 +31,10 @@
 
 package org.apache.http.message;
 
-
 import org.apache.http.HeaderElement;
 import org.apache.http.NameValuePair;
 import org.apache.http.util.CharArrayBuffer;
 
-
-
 /**
  * Interface for formatting elements of a header value.
  * This is the complement to {@link HeaderValueParser}.
@@ -74,9 +71,7 @@
      */
     CharArrayBuffer formatElements(CharArrayBuffer buffer,
                                    HeaderElement[] elems,
-                                   boolean quote)
-        ;
-
+                                   boolean quote);
 
     /**
      * Formats one header element.
@@ -93,10 +88,7 @@
      */
     CharArrayBuffer formatHeaderElement(CharArrayBuffer buffer,
                                         HeaderElement elem,
-                                        boolean quote)
-        ;
-
-
+                                        boolean quote);
 
     /**
      * Formats the parameters of a header element.
@@ -115,9 +107,7 @@
      */
     CharArrayBuffer formatParameters(CharArrayBuffer buffer,
                                      NameValuePair[] nvps,
-                                     boolean quote)
-        ;
-
+                                     boolean quote);
 
     /**
      * Formats one name-value pair, where the value is optional.
@@ -134,8 +124,7 @@
      */
     CharArrayBuffer formatNameValuePair(CharArrayBuffer buffer,
                                         NameValuePair nvp,
-                                        boolean quote)
-        ;
+                                        boolean quote);
 
 }
 

Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/HeaderValueParser.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/HeaderValueParser.java?rev=728464&r1=728463&r2=728464&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/HeaderValueParser.java
(original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/HeaderValueParser.java
Sun Dec 21 09:59:05 2008
@@ -31,14 +31,11 @@
 
 package org.apache.http.message;
 
-
 import org.apache.http.HeaderElement;
 import org.apache.http.NameValuePair;
 import org.apache.http.ParseException;
 import org.apache.http.util.CharArrayBuffer;
 
-
-
 /**
  * Interface for parsing header values into elements.
  * Instances of this interface are expected to be stateless and thread-safe.
@@ -112,76 +109,7 @@
     /**
      * Parses a list of name-value pairs.
      * These lists are used to specify parameters to a header element.
-     * Parse errors are indicated as <code>RuntimeException</code>.
-     * <p>
-     * This method comforms to the generic grammar and formatting rules
-     * outlined in the 
-     * <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec2.html#sec2.2"
-     *   >Section 2.2</a>
-     * and
-     * <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.6"
-     *   >Section 3.6</a>
-     * of
-     * <a href="http://www.w3.org/Protocols/rfc2616/rfc2616.txt">RFC 2616</a>.
-     * </p>
-     * <h>2.2 Basic Rules</h>
-     * <p>
-     * The following rules are used throughout this specification to
-     * describe basic parsing constructs. 
-     * The US-ASCII coded character set is defined by ANSI X3.4-1986.
-     * </p>
-     * <pre>
-     *     OCTET          = <any 8-bit sequence of data>
-     *     CHAR           = <any US-ASCII character (octets 0 - 127)>
-     *     UPALPHA        = <any US-ASCII uppercase letter "A".."Z">
-     *     LOALPHA        = <any US-ASCII lowercase letter "a".."z">
-     *     ALPHA          = UPALPHA | LOALPHA
-     *     DIGIT          = <any US-ASCII digit "0".."9">
-     *     CTL            = <any US-ASCII control character
-     *                      (octets 0 - 31) and DEL (127)>
-     *     CR             = <US-ASCII CR, carriage return (13)>
-     *     LF             = <US-ASCII LF, linefeed (10)>
-     *     SP             = <US-ASCII SP, space (32)>
-     *     HT             = <US-ASCII HT, horizontal-tab (9)>
-     *     <">            = <US-ASCII double-quote mark (34)>
-     * </pre>
-     * <p>
-     * Many HTTP/1.1 header field values consist of words separated
-     * by LWS or special characters. These special characters MUST be
-     * in a quoted string to be used within 
-     * a parameter value (as defined in section 3.6).
-     * <p>
-     * <pre>
-     * token          = 1*<any CHAR except CTLs or separators>
-     * separators     = "(" | ")" | "<" | ">" | "@"
-     *                | "," | ";" | ":" | "\" | <">
-     *                | "/" | "[" | "]" | "?" | "="
-     *                | "{" | "}" | SP | HT
-     * </pre>
-     * <p>
-     * A string of text is parsed as a single word if it is quoted using
-     * double-quote marks.
-     * </p>
-     * <pre>
-     * quoted-string  = ( <"> *(qdtext | quoted-pair ) <"> )
-     * qdtext         = <any TEXT except <">>
-     * </pre>
-     * <p>
-     * The backslash character ("\") MAY be used as a single-character
-     * quoting mechanism only within quoted-string and comment constructs.
-     * </p>
-     * <pre>
-     * quoted-pair    = "\" CHAR
-     * </pre>
-     * <h>3.6 Transfer Codings</h>
-     * <p>
-     * Parameters are in the form of attribute/value pairs.
-     * </p>
-     * <pre>
-     * parameter               = attribute "=" value
-     * attribute               = token
-     * value                   = token | quoted-string
-     * </pre> 
+     * Parse errors are indicated as <code>ParseException</code>.
      *
      * @param buffer    buffer holding the name-value list to parse
      * @param cursor    the parser cursor containing the current position and 

Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/LineFormatter.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/LineFormatter.java?rev=728464&r1=728463&r2=728464&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/LineFormatter.java
(original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/LineFormatter.java
Sun Dec 21 09:59:05 2008
@@ -31,14 +31,12 @@
 
 package org.apache.http.message;
 
-
 import org.apache.http.ProtocolVersion;
 import org.apache.http.RequestLine;
 import org.apache.http.StatusLine;
 import org.apache.http.Header;
 import org.apache.http.util.CharArrayBuffer;
 
-
 /**
  * Interface for formatting elements of the HEAD section of an HTTP message.
  * This is the complement to {@link LineParser}.
@@ -71,8 +69,6 @@
  */
 public interface LineFormatter {
 
-
-
     /**
      * Formats a protocol version.
      * This method does <i>not</i> follow the general contract for
@@ -91,9 +87,7 @@
      *          the returned buffer is the argument buffer.
      */
     CharArrayBuffer appendProtocolVersion(CharArrayBuffer buffer,
-                                          ProtocolVersion version)
-        ;
-
+                                          ProtocolVersion version);
 
     /**
      * Formats a request line.
@@ -106,9 +100,7 @@
      * @return  the formatted request line
      */
     CharArrayBuffer formatRequestLine(CharArrayBuffer buffer,
-                                      RequestLine reqline) 
-        ;
-
+                                      RequestLine reqline);
 
     /**
      * Formats a status line.
@@ -123,9 +115,7 @@
      * @throws ParseException        in case of a parse error
      */
     CharArrayBuffer formatStatusLine(CharArrayBuffer buffer,
-                                     StatusLine statline) 
-        ;
-
+                                     StatusLine statline);
 
     /**
      * Formats a header.
@@ -147,7 +137,6 @@
      * @throws ParseException        in case of a parse error
      */
     CharArrayBuffer formatHeader(CharArrayBuffer buffer,
-                                 Header header)
-        ;
+                                 Header header);
 
 }

Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/LineParser.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/LineParser.java?rev=728464&r1=728463&r2=728464&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/LineParser.java
(original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/message/LineParser.java
Sun Dec 21 09:59:05 2008
@@ -31,7 +31,6 @@
 
 package org.apache.http.message;
 
-
 import org.apache.http.ProtocolVersion;
 import org.apache.http.ParseException;
 import org.apache.http.RequestLine;
@@ -39,7 +38,6 @@
 import org.apache.http.Header;
 import org.apache.http.util.CharArrayBuffer;
 
-
 /**
  * Interface for parsing lines in the HEAD section of an HTTP message.
  * There are individual methods for parsing a request line, a
@@ -58,7 +56,6 @@
  */
 public interface LineParser {
 
-
     /**
      * Parses the textual representation of a protocol version.
      * This is needed for parsing request lines (last element)
@@ -76,7 +73,6 @@
             CharArrayBuffer buffer,
             ParserCursor cursor) throws ParseException;
 
-
     /**
      * Checks whether there likely is a protocol version in a line.
      * This method implements a <i>heuristic</i> to check for a
@@ -100,7 +96,6 @@
             CharArrayBuffer buffer, 
             ParserCursor cursor);
 
-
     /**
      * Parses a request line.
      *
@@ -116,7 +111,6 @@
             CharArrayBuffer buffer,
             ParserCursor cursor) throws ParseException;
 
-
     /**
      * Parses a status line.
      *
@@ -132,7 +126,6 @@
             CharArrayBuffer buffer,
             ParserCursor cursor) throws ParseException;
 
-
     /**
      * Creates a header from a line.
      * The full header line is expected here. Header continuation lines
@@ -149,8 +142,6 @@
      * @throws ParseException        in case of a parse error
      */
     Header parseHeader(CharArrayBuffer buffer)
-        throws ParseException
-        ;
-
+        throws ParseException;
 
 }



Mime
View raw message