You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hc.apache.org by ol...@apache.org on 2008/12/13 14:57:09 UTC
svn commit: r726211 - in /httpcomponents/httpcore/trunk:
module-main/src/main/java/org/apache/http/ module-osgi-bundle/
Author: olegk
Date: Sat Dec 13 05:57:09 2008
New Revision: 726211
URL: http://svn.apache.org/viewvc?rev=726211&view=rev
Log:
javadoc updates
Modified:
httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/ConnectionClosedException.java
httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/ConnectionReuseStrategy.java
httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/FormattedHeader.java
httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HeaderElement.java
httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HeaderElementIterator.java
httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HeaderIterator.java
httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpClientConnection.java
httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpConnection.java
httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpEntity.java
httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpEntityEnclosingRequest.java
httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpMessage.java
httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpRequest.java
httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpResponse.java
httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpServerConnection.java
httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpVersion.java
httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/NameValuePair.java
httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/NoHttpResponseException.java
httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/ProtocolVersion.java
httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/RequestLine.java
httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/StatusLine.java
httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/TokenIterator.java
httpcomponents/httpcore/trunk/module-osgi-bundle/ (props changed)
Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/ConnectionClosedException.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/ConnectionClosedException.java?rev=726211&r1=726210&r2=726211&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/ConnectionClosedException.java (original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/ConnectionClosedException.java Sat Dec 13 05:57:09 2008
@@ -34,7 +34,7 @@
import java.io.IOException;
/**
- * Indicates that a connection has been closed.
+ * Signals that the connection has been closed unexpectedly.
*
* @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
*
Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/ConnectionReuseStrategy.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/ConnectionReuseStrategy.java?rev=726211&r1=726210&r2=726211&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/ConnectionReuseStrategy.java (original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/ConnectionReuseStrategy.java Sat Dec 13 05:57:09 2008
@@ -34,7 +34,8 @@
import org.apache.http.protocol.HttpContext;
/**
- * Interface for deciding whether a connection should be kept alive.
+ * Interface for deciding whether a connection can be re-used for
+ * subsequent requests and should be kept alive.
*
* @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
*
@@ -49,7 +50,7 @@
/**
* Decides whether a connection can be kept open after a request.
* If this method returns <code>false</code>, the caller MUST
- * close the connection to correctly implement the HTTP protocol.
+ * close the connection to correctly comply with the HTTP protocol.
* If it returns <code>true</code>, the caller SHOULD attempt to
* keep the connection open for reuse with another request.
* <br/>
Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/FormattedHeader.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/FormattedHeader.java?rev=726211&r1=726210&r2=726211&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/FormattedHeader.java (original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/FormattedHeader.java Sat Dec 13 05:57:09 2008
@@ -44,15 +44,13 @@
*/
public interface FormattedHeader extends Header {
-
/**
* Obtains the buffer with the formatted header.
* The returned buffer MUST NOT be modified.
*
* @return the formatted header, in a buffer that must not be modified
*/
- CharArrayBuffer getBuffer()
- ;
+ CharArrayBuffer getBuffer();
/**
* Obtains the start of the header value in the {@link #getBuffer buffer}.
@@ -62,7 +60,6 @@
* @return index of the first character of the header value
* in the buffer returned by {@link #getBuffer getBuffer}.
*/
- int getValuePos()
- ;
+ int getValuePos();
}
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=726211&r1=726210&r2=726211&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 Sat Dec 13 05:57:09 2008
@@ -32,7 +32,9 @@
package org.apache.http;
/**
- * One element of an HTTP {@link Header header} value.
+ * One element of an HTTP {@link Header header} value. Header element
+ * is a name / value pair with a number of optional name / value
+ * parameters.
*
* @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
*
@@ -44,16 +46,50 @@
*/
public interface HeaderElement {
+ /**
+ * Returns header element name.
+ *
+ * @return header element name
+ */
String getName();
+ /**
+ * Returns header element value.
+ *
+ * @return header element value
+ */
String getValue();
+ /**
+ * Returns an array of name / value pairs.
+ *
+ * @return array of name / value pairs
+ */
NameValuePair[] getParameters();
+ /**
+ * Returns the first parameter with the given name.
+ *
+ * @param name parameter name
+ *
+ * @return name / value pair
+ */
NameValuePair getParameterByName(String name);
+ /**
+ * Returns the total count of parameters.
+ *
+ * @return parameter count
+ */
int getParameterCount();
+ /**
+ * Returns parameter with the given index.
+ *
+ * @param index
+ * @return name / value pair
+ */
NameValuePair getParameter(int index);
+
}
Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HeaderElementIterator.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HeaderElementIterator.java?rev=726211&r1=726210&r2=726211&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HeaderElementIterator.java (original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HeaderElementIterator.java Sat Dec 13 05:57:09 2008
@@ -34,7 +34,7 @@
import java.util.Iterator;
/**
- * A type-safe iterator for {@link HeaderElement HeaderElement} objects.
+ * A type-safe iterator for {@link HeaderElement} objects.
*
* @version $Revision$
*/
Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HeaderIterator.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HeaderIterator.java?rev=726211&r1=726210&r2=726211&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HeaderIterator.java (original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HeaderIterator.java Sat Dec 13 05:57:09 2008
@@ -36,7 +36,7 @@
/**
- * A type-safe iterator for {@link Header Header} objects.
+ * A type-safe iterator for {@link Header} objects.
*
* @version $Revision$
*/
Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpClientConnection.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpClientConnection.java?rev=726211&r1=726210&r2=726211&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpClientConnection.java (original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpClientConnection.java Sat Dec 13 05:57:09 2008
@@ -34,8 +34,8 @@
import java.io.IOException;
/**
- * An HTTP connection for use on the client side.
- * It is used for sending requests and receiving responses.
+ * A client-side HTTP connection, which can be used for sending
+ * requests and receiving responses.
*
* @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
*
Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpConnection.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpConnection.java?rev=726211&r1=726210&r2=726211&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpConnection.java (original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpConnection.java Sat Dec 13 05:57:09 2008
@@ -46,8 +46,8 @@
/**
* Closes this connection gracefully.
- * This method will attempt to flush the transmitter's
- * internal buffer prior to closing the underlying socket.
+ * This method will attempt to flush the internal output
+ * buffer prior to closing the underlying socket.
* This method MUST NOT be called from a different thread to force
* shutdown of the connection. Use {@link #shutdown shutdown} instead.
*/
@@ -102,7 +102,8 @@
public void shutdown() throws IOException;
/**
- * Returns a collection of connection metrcis
+ * Returns a collection of connection metrics.
+ *
* @return HttpConnectionMetrics
*/
HttpConnectionMetrics getMetrics();
Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpEntity.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpEntity.java?rev=726211&r1=726210&r2=726211&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpEntity.java (original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpEntity.java Sat Dec 13 05:57:09 2008
@@ -41,7 +41,7 @@
* {@link HttpEntityEnclosingRequest requests} and in
* {@link HttpResponse responses}, where they are optional.
* <p>
- * In some places, the JavaDoc distinguishes three kinds of entities,
+ * There are three distinct types of entities in HttpCore,
* depending on where their {@link #getContent content} originates:
* <ul>
* <li><b>streamed</b>: The content is received from a stream, or
@@ -73,7 +73,7 @@
public interface HttpEntity {
/**
- * Tells if the entity is capable to produce its data more than once.
+ * Tells if the entity is capable of producing its data more than once.
* A repeatable entity's getContent() and writeTo(OutputStream) methods
* can be called more than once whereas a non-repeatable entity's can not.
* @return true if the entity is repeatable, false otherwise.
Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpEntityEnclosingRequest.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpEntityEnclosingRequest.java?rev=726211&r1=726210&r2=726211&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpEntityEnclosingRequest.java (original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpEntityEnclosingRequest.java Sat Dec 13 05:57:09 2008
@@ -53,11 +53,17 @@
boolean expectContinue();
/**
- * Hands the entity to the request.
+ * Associates the entity with this request.
+ *
* @param entity the entity to send.
*/
void setEntity(HttpEntity entity);
+ /**
+ * Returns the entity associated with this request.
+ *
+ * @return entity
+ */
HttpEntity getEntity();
}
Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpMessage.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpMessage.java?rev=726211&r1=726210&r2=726211&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpMessage.java (original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpMessage.java Sat Dec 13 05:57:09 2008
@@ -34,8 +34,26 @@
import org.apache.http.params.HttpParams;
/**
- * A generic HTTP message.
- * Holds what is common between requests and responses.
+ * HTTP messages consist of requests from client to server and responses
+ * from server to client.
+ * <pre>
+ * HTTP-message = Request | Response ; HTTP/1.1 messages
+ * </pre>
+ * <p>
+ * HTTP messages use the generic message format of RFC 822 for
+ * transferring entities (the payload of the message). Both types
+ * of message consist of a start-line, zero or more header fields
+ * (also known as "headers"), an empty line (i.e., a line with nothing
+ * preceding the CRLF) indicating the end of the header fields,
+ * and possibly a message-body.
+ * </p>
+ * <pre>
+ * generic-message = start-line
+ * *(message-header CRLF)
+ * CRLF
+ * [ message-body ]
+ * start-line = Request-Line | Status-Line
+ * </pre>
*
* @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
*
Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpRequest.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpRequest.java?rev=726211&r1=726210&r2=726211&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpRequest.java (original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpRequest.java Sat Dec 13 05:57:09 2008
@@ -32,7 +32,17 @@
package org.apache.http;
/**
- * An HTTP request.
+ * A request message from a client to a server includes, within the
+ * first line of that message, the method to be applied to the resource,
+ * the identifier of the resource, and the protocol version in use.
+ * <pre>
+ * Request = Request-Line
+ * *(( general-header
+ * | request-header
+ * | entity-header ) CRLF)
+ * CRLF
+ * [ message-body ]
+ * </pre>
*
* @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
*
Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpResponse.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpResponse.java?rev=726211&r1=726210&r2=726211&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpResponse.java (original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpResponse.java Sat Dec 13 05:57:09 2008
@@ -31,12 +31,19 @@
package org.apache.http;
-
import java.util.Locale;
-
/**
- * An HTTP response.
+ * After receiving and interpreting a request message, a server responds
+ * with an HTTP response message.
+ * <pre>
+ * Response = Status-Line
+ * *(( general-header
+ * | response-header
+ * | entity-header ) CRLF)
+ * CRLF
+ * [ message-body ]
+ * </pre>
*
* @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
*
Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpServerConnection.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpServerConnection.java?rev=726211&r1=726210&r2=726211&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpServerConnection.java (original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpServerConnection.java Sat Dec 13 05:57:09 2008
@@ -34,8 +34,8 @@
import java.io.IOException;
/**
- * An HTTP connection for use on the server side.
- * Requests are received, responses are sent.
+ * A server-side HTTP connection, which can be used for receiving
+ * requests and sending responses.
*
* @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
*
Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpVersion.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpVersion.java?rev=726211&r1=726210&r2=726211&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpVersion.java (original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpVersion.java Sat Dec 13 05:57:09 2008
@@ -34,7 +34,15 @@
import java.io.Serializable;
/**
- * Represents an HTTP version, as specified in RFC 2616.
+ * Represents an HTTP version. HTTP uses a "major.minor" numbering
+ * scheme to indicate versions of the protocol.
+ * <p>
+ * The version of an HTTP message is indicated by an HTTP-Version field
+ * in the first line of the message.
+ * </p>
+ * <pre>
+ * HTTP-Version = "HTTP" "/" 1*DIGIT "." 1*DIGIT
+ * </pre>
*
* @author <a href="mailto:oleg@ural.ru">Oleg Kalnichevski</a>
*
Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/NameValuePair.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/NameValuePair.java?rev=726211&r1=726210&r2=726211&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/NameValuePair.java (original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/NameValuePair.java Sat Dec 13 05:57:09 2008
@@ -32,64 +32,7 @@
package org.apache.http;
/**
- * 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>
+ * A name / value pair parameter used as an element of HTTP messages.
* <pre>
* parameter = attribute "=" value
* attribute = token
Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/NoHttpResponseException.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/NoHttpResponseException.java?rev=726211&r1=726210&r2=726211&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/NoHttpResponseException.java (original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/NoHttpResponseException.java Sat Dec 13 05:57:09 2008
@@ -34,9 +34,7 @@
import java.io.IOException;
/**
- * <p>
* Signals that the target server failed to respond with a valid HTTP response.
- * </p>
*
* @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
*
Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/ProtocolVersion.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/ProtocolVersion.java?rev=726211&r1=726210&r2=726211&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/ProtocolVersion.java (original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/ProtocolVersion.java Sat Dec 13 05:57:09 2008
@@ -34,19 +34,15 @@
import java.io.Serializable;
import org.apache.http.util.CharArrayBuffer;
-
/**
- * Represents a protocol version, as specified in RFC 2616.
- * RFC 2616 specifies only HTTP versions, like "HTTP/1.1" and "HTTP/1.0".
- * RFC 3261 specifies a message format that is identical to HTTP except
- * for the protocol name. It defines a protocol version "SIP/2.0".
- * There are some nitty-gritty differences between the interpretation
- * of versions in HTTP and SIP. In those cases, HTTP takes precedence.
+ * Represents a protocol version. The "major.minor" numbering
+ * scheme is used to indicate versions of the protocol.
* <p>
* This class defines a protocol version as a combination of
* protocol name, major version number, and minor version number.
* Note that {@link #equals} and {@link #hashCode} are defined as
* final here, they cannot be overridden in derived classes.
+ * </p>
*
* @author <a href="mailto:oleg@ural.ru">Oleg Kalnichevski</a>
* @author <a href="mailto:rolandw at apache.org">Roland Weber</a>
Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/RequestLine.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/RequestLine.java?rev=726211&r1=726210&r2=726211&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/RequestLine.java (original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/RequestLine.java Sat Dec 13 05:57:09 2008
@@ -32,9 +32,13 @@
package org.apache.http;
/**
- * The first line of an {@link HttpRequest HttpRequest}.
- * It contains the method, URI, and HTTP version of the request.
- * For details, see RFC 2616.
+ * The Request-Line begins with a method token, followed by the
+ * Request-URI and the protocol version, and ending with CRLF. The
+ * elements are separated by SP characters. No CR or LF is allowed
+ * except in the final CRLF sequence.
+ * <pre>
+ * Request-Line = Method SP Request-URI SP HTTP-Version CRLF
+ * </pre>
*
* @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
*
Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/StatusLine.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/StatusLine.java?rev=726211&r1=726210&r2=726211&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/StatusLine.java (original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/StatusLine.java Sat Dec 13 05:57:09 2008
@@ -32,11 +32,14 @@
package org.apache.http;
/**
- * 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.
- * Implementations are expected to be thread safe.
- *
+ * The first line of a Response message is the Status-Line, consisting
+ * of the protocol version followed by a numeric status code and its
+ * associated textual phrase, with each element separated by SP
+ * characters. No CR or LF is allowed except in the final CRLF sequence.
+ * <pre>
+ * Status-Line = HTTP-Version SP Status-Code SP Reason-Phrase CRLF
+ * </pre>
+ *
* @see HttpStatus
* @author <a href="mailto:jsdever@apache.org">Jeff Dever</a>
* @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
Modified: httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/TokenIterator.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/TokenIterator.java?rev=726211&r1=726210&r2=726211&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/TokenIterator.java (original)
+++ httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/TokenIterator.java Sat Dec 13 05:57:09 2008
@@ -31,10 +31,8 @@
package org.apache.http;
-
import java.util.Iterator;
-
/**
* An iterator for {@link String} tokens.
* This interface is designed as a complement to
@@ -51,9 +49,7 @@
* @return <code>true</code> if there is another token,
* <code>false</code> otherwise
*/
- boolean hasNext()
- ;
-
+ boolean hasNext();
/**
* Obtains the next token from this iteration.
@@ -62,6 +58,6 @@
*
* @return the next token in this iteration
*/
- String nextToken()
- ;
+ String nextToken();
+
}
Propchange: httpcomponents/httpcore/trunk/module-osgi-bundle/
------------------------------------------------------------------------------
--- svn:ignore (added)
+++ svn:ignore Sat Dec 13 05:57:09 2008
@@ -0,0 +1 @@
+target