hc-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rola...@apache.org
Subject svn commit: r619550 - in /httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http: conn/params/HttpRouteParams.java impl/conn/ProxySelectorRoutePlanner.java
Date Thu, 07 Feb 2008 18:37:24 GMT
Author: rolandw
Date: Thu Feb  7 10:37:21 2008
New Revision: 619550

URL: http://svn.apache.org/viewvc?rev=619550&view=rev
Log:
fixed and extended JavaDocs

Modified:
    httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/conn/params/HttpRouteParams.java
    httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/conn/ProxySelectorRoutePlanner.java

Modified: httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/conn/params/HttpRouteParams.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/conn/params/HttpRouteParams.java?rev=619550&r1=619549&r2=619550&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/conn/params/HttpRouteParams.java
(original)
+++ httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/conn/params/HttpRouteParams.java
Thu Feb  7 10:37:21 2008
@@ -67,7 +67,6 @@
     public static final HttpRoute NO_ROUTE = new HttpRoute(NO_HOST);
 
 
-
     /** Disabled default constructor. */
     private HttpRouteParams() {
         // no body
@@ -165,12 +164,13 @@
     /**
      * Obtains the {@link ConnRoutePNames#LOCAL_ADDRESS LOCAL_ADDRESS}
      * parameter value.
-     * {@link #NO_HOST} will be mapped to <code>null</code>,
-     * to allow unsetting in a hierarchy.
+     * There is no special value that would automatically be mapped to
+     * <code>null</code>. You can use the wildcard address (0.0.0.0 for IPv4,
+     * :: for IPv6) to override a specific local address in a hierarchy.
      *
      * @param params    the parameters in which to look up
      *
-     * @return  the default proxy set in the argument parameters, or
+     * @return  the local address set in the argument parameters, or
      *          <code>null</code> if not set
      */
     public final static InetAddress getLocalAddress(HttpParams params) {
@@ -179,7 +179,7 @@
         }
         InetAddress local = (InetAddress)
             params.getParameter(ConnRoutePNames.LOCAL_ADDRESS);
-        // currently no explicit unsetting
+        // no explicit unsetting
         return local;
     }
 
@@ -189,7 +189,7 @@
      * parameter value.
      *
      * @param params    the parameters in which to set the value
-     * @param local     the value to set, may be <code>null</code>.
+     * @param local     the value to set, may be <code>null</code>
      */
     public final static void setLocalAddress(HttpParams params,
                                              InetAddress local) {

Modified: httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/conn/ProxySelectorRoutePlanner.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/conn/ProxySelectorRoutePlanner.java?rev=619550&r1=619549&r2=619550&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/conn/ProxySelectorRoutePlanner.java
(original)
+++ httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/conn/ProxySelectorRoutePlanner.java
Thu Feb  7 10:37:21 2008
@@ -60,7 +60,8 @@
  * from system properties or from the browser running the application.
  * Additionally, it interprets some
  * {@link org.apache.http.conn.params.ConnRoutePNames parameters},
- * though not the {@link ConnRoutePNames#DEFAULT_PROXY DEFAULT_PROXY}.
+ * though not the {@link
+ * org.apache.http.conn.params.ConnRoutePNames#DEFAULT_PROXY DEFAULT_PROXY}.
  */
 public class ProxySelectorRoutePlanner implements HttpRoutePlanner {
     



Mime
View raw message