You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hc.apache.org by ro...@apache.org on 2006/07/23 12:23:48 UTC
svn commit: r424702 - in
/jakarta/httpcomponents/httpcore/trunk/src/java/org/apache/http: ./ message/
Author: rolandw
Date: Sun Jul 23 03:23:46 2006
New Revision: 424702
URL: http://svn.apache.org/viewvc?rev=424702&view=rev
Log:
JavaDoc fixes
Modified:
jakarta/httpcomponents/httpcore/trunk/src/java/org/apache/http/HeaderElement.java
jakarta/httpcomponents/httpcore/trunk/src/java/org/apache/http/HttpClientConnection.java
jakarta/httpcomponents/httpcore/trunk/src/java/org/apache/http/HttpProxyConnection.java
jakarta/httpcomponents/httpcore/trunk/src/java/org/apache/http/message/BasicHeader.java
jakarta/httpcomponents/httpcore/trunk/src/java/org/apache/http/message/BasicHeaderElement.java
jakarta/httpcomponents/httpcore/trunk/src/java/org/apache/http/message/BasicRequestLine.java
jakarta/httpcomponents/httpcore/trunk/src/java/org/apache/http/message/BufferedHeader.java
Modified: jakarta/httpcomponents/httpcore/trunk/src/java/org/apache/http/HeaderElement.java
URL: http://svn.apache.org/viewvc/jakarta/httpcomponents/httpcore/trunk/src/java/org/apache/http/HeaderElement.java?rev=424702&r1=424701&r2=424702&view=diff
==============================================================================
--- jakarta/httpcomponents/httpcore/trunk/src/java/org/apache/http/HeaderElement.java (original)
+++ jakarta/httpcomponents/httpcore/trunk/src/java/org/apache/http/HeaderElement.java Sun Jul 23 03:23:46 2006
@@ -30,51 +30,15 @@
package org.apache.http;
/**
- * <p>One element of an HTTP header's value.</p>
- * <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 ] ]
+ * One element of an HTTP {@link Header header} value.
*
- * name = token
- * value = ( token | quoted-string )
- *
- * token = 1*<any char except "=", ",", ";", <"> and
- * white space>
- * quoted-string = <"> *( text | quoted-char ) <">
- * text = any char except <">
- * 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>
- * <p>
- * This class also exposes a {@link #parse} method for parsing a
- * {@link Header} value into an array of elements.
- * </p>
+ * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
*
- * @see Header
*
- * @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.ru">Oleg Kalnichevski</a>
+ * <!-- empty lines above to avoid 'svn diff' context problems -->
+ * @version $Revision$ $Date$
*
* @since 1.0
- * @version $Revision$ $Date$
*/
public interface HeaderElement {
Modified: jakarta/httpcomponents/httpcore/trunk/src/java/org/apache/http/HttpClientConnection.java
URL: http://svn.apache.org/viewvc/jakarta/httpcomponents/httpcore/trunk/src/java/org/apache/http/HttpClientConnection.java?rev=424702&r1=424701&r2=424702&view=diff
==============================================================================
--- jakarta/httpcomponents/httpcore/trunk/src/java/org/apache/http/HttpClientConnection.java (original)
+++ jakarta/httpcomponents/httpcore/trunk/src/java/org/apache/http/HttpClientConnection.java Sun Jul 23 03:23:46 2006
@@ -41,6 +41,8 @@
*
* @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
*
+ *
+ * <!-- empty lines above to avoid 'svn diff' context problems -->
* @version $Revision$
*
* @since 4.0
@@ -48,27 +50,29 @@
public interface HttpClientConnection extends HttpConnection {
/**
- * Returns the current target host as set by @link #setTargetHost(HttpHost).
- * @return the target host of this connection
+ * Returns the current target host.
+ *
+ * @return the target host, as set by {@link #setTargetHost setTargetHost}.
*/
HttpHost getTargetHost();
/**
* Provides the implementation with the host it is supposed to connect to.
* The host must be set prior to a call to
- *
- * @link #open(HttpParams). The target host can only be set as long as the
- * connection is not open.
+ * {@link #open(HttpParams) open}.
+ * The target host can only be set as long as the connection is not open.
+ *
* @param targethost the host to connect to
*/
void setTargetHost(HttpHost targethost);
-
+
/**
- * The local address the connection is or will be bound to as set by
+ * The local address of the connection.
+ * The connection is or will be bound to this address.
*
- * @link #setLocalAddress(InetAddress) or <code>null</code> if
- * unspecified.
- * @return local address the connection
+ * @return local address of this connection as set by
+ * {@link #setLocalAddress setLocalAddress}, or
+ * <code>null</code> if unspecified
*/
InetAddress getLocalAddress();
Modified: jakarta/httpcomponents/httpcore/trunk/src/java/org/apache/http/HttpProxyConnection.java
URL: http://svn.apache.org/viewvc/jakarta/httpcomponents/httpcore/trunk/src/java/org/apache/http/HttpProxyConnection.java?rev=424702&r1=424701&r2=424702&view=diff
==============================================================================
--- jakarta/httpcomponents/httpcore/trunk/src/java/org/apache/http/HttpProxyConnection.java (original)
+++ jakarta/httpcomponents/httpcore/trunk/src/java/org/apache/http/HttpProxyConnection.java Sun Jul 23 03:23:46 2006
@@ -34,18 +34,24 @@
import org.apache.http.params.HttpParams;
/**
- * An HTTP connection through a proxy. The semantics of
- * @link org.apache.http.HttpClientConnection#setTargetHost(HttpHost) and
- * @link org.apache.http.HttpClientConnection#getTargetHost() methods of a proxy
- * connections change their meaning to designate the proxy host.
-
+ * An HTTP connection through a proxy.
+ * The semantics of the
+ * {@link HttpClientConnection#setTargetHost setTargetHost} and
+ * {@link HttpClientConnection#getTargetHost getTargetHost}
+ * methods of a the base interface change their meaning to designate
+ * the proxy host instead of the target host.
+ *
* @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
+ *
+ *
+ * <!-- empty lines above to avoid 'svn diff' context problems -->
* @version $Revision$
* @since 4.0
*/
public interface HttpProxyConnection extends HttpClientConnection {
/**
+ * Creates a tunnelled connection through the proxy.
* After this connection is opened to the proxy, this method may be called
* to create a new connection over it. Subsequent data is sent over the
* resulting connection.
@@ -57,24 +63,25 @@
void tunnelTo(HttpHost targetHost, HttpParams params) throws IOException;
/**
- * Returns the target host as provided by
- *
- * @link #tunnelTo(HttpHost, HttpParams).
+ * Obtains the target host of a tunnel through a proxy.
+ *
+ * @return the target host provided to {@link #tunnelTo tunnelTo}
*/
HttpHost getTunnelTarget();
/**
- * Checks if
+ * Checks if this connection is tunnelled.
+ *
+ * @return <code>true</code> if {@link #tunnelTo tunnelTo} has been called,
+ * <code>false</code> otherwise
*
- * @link #tunnelTo(HttpHost, HttpParams) has been called on this connection.
- * @return true if tunnelTo has been called, false if not
*/
boolean isTunnelActive();
/**
- * Checks if the tunnel uses a secure socket.
+ * Checks if the tunnel uses a secure connection.
*
- * @return true if this is a secure tunnel.
+ * @return <code>true</code> if this is a secure tunnel
*/
boolean isSecure();
Modified: jakarta/httpcomponents/httpcore/trunk/src/java/org/apache/http/message/BasicHeader.java
URL: http://svn.apache.org/viewvc/jakarta/httpcomponents/httpcore/trunk/src/java/org/apache/http/message/BasicHeader.java?rev=424702&r1=424701&r2=424702&view=diff
==============================================================================
--- jakarta/httpcomponents/httpcore/trunk/src/java/org/apache/http/message/BasicHeader.java (original)
+++ jakarta/httpcomponents/httpcore/trunk/src/java/org/apache/http/message/BasicHeader.java Sun Jul 23 03:23:46 2006
@@ -54,6 +54,9 @@
* @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$
*/
public class BasicHeader implements Header {
@@ -119,7 +122,7 @@
/**
* Returns an array of {@link HeaderElement}s constructed from my value.
*
- * @see HeaderElement#parseAll
+ * @see BasicHeaderElement#parseAll
*
* @return an array of header elements
*
Modified: jakarta/httpcomponents/httpcore/trunk/src/java/org/apache/http/message/BasicHeaderElement.java
URL: http://svn.apache.org/viewvc/jakarta/httpcomponents/httpcore/trunk/src/java/org/apache/http/message/BasicHeaderElement.java?rev=424702&r1=424701&r2=424702&view=diff
==============================================================================
--- jakarta/httpcomponents/httpcore/trunk/src/java/org/apache/http/message/BasicHeaderElement.java (original)
+++ jakarta/httpcomponents/httpcore/trunk/src/java/org/apache/http/message/BasicHeaderElement.java Sun Jul 23 03:23:46 2006
@@ -38,7 +38,7 @@
import org.apache.http.util.LangUtils;
/**
- * <p>One element of an HTTP header's value.</p>
+ * 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
@@ -71,18 +71,19 @@
* </p>
* <p>
* This class also exposes a {@link #parse} method for parsing a
- * {@link Header} value into an array of elements.
+ * {@link org.apache.http.Header} value into an array of elements.
* </p>
*
- * @see Header
- *
* @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$
*
* @since 1.0
- * @version $Revision$ $Date$
*/
public class BasicHeaderElement implements HeaderElement {
Modified: jakarta/httpcomponents/httpcore/trunk/src/java/org/apache/http/message/BasicRequestLine.java
URL: http://svn.apache.org/viewvc/jakarta/httpcomponents/httpcore/trunk/src/java/org/apache/http/message/BasicRequestLine.java?rev=424702&r1=424701&r2=424702&view=diff
==============================================================================
--- jakarta/httpcomponents/httpcore/trunk/src/java/org/apache/http/message/BasicRequestLine.java (original)
+++ jakarta/httpcomponents/httpcore/trunk/src/java/org/apache/http/message/BasicRequestLine.java Sun Jul 23 03:23:46 2006
@@ -36,12 +36,14 @@
import org.apache.http.protocol.HTTP;
/**
- * The first line of an {@link HttpRequest HttpRequest}.
+ * 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>
*
+ *
+ * <!-- empty lines above to avoid 'svn diff' context problems -->
* @version $Revision$
*
* @since 4.0
Modified: jakarta/httpcomponents/httpcore/trunk/src/java/org/apache/http/message/BufferedHeader.java
URL: http://svn.apache.org/viewvc/jakarta/httpcomponents/httpcore/trunk/src/java/org/apache/http/message/BufferedHeader.java?rev=424702&r1=424701&r2=424702&view=diff
==============================================================================
--- jakarta/httpcomponents/httpcore/trunk/src/java/org/apache/http/message/BufferedHeader.java (original)
+++ jakarta/httpcomponents/httpcore/trunk/src/java/org/apache/http/message/BufferedHeader.java Sun Jul 23 03:23:46 2006
@@ -38,6 +38,10 @@
* the header value needs to be consumed.
*
* @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
+ *
+ *
+ * <!-- empty lines above to avoid 'svn diff' context problems -->
+ * @version $Revision$ $Date$
*/
public class BufferedHeader implements Header {
@@ -55,11 +59,14 @@
* The beginning of the header value in the buffer
*/
private final int valuePos;
+
+
/**
- * Constructor with name and value
+ * Creates a new header from a buffer.
+ * The name of the header will be parsed immediately,
+ * the value only if it is accessed.
*
- * @param name the header name
- * @param value the header value
+ * @param buffer the buffer containing the header to represent
*/
public BufferedHeader(final CharArrayBuffer buffer) {
super();