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 2007/07/23 21:02:33 UTC

svn commit: r558833 - in /jakarta/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http: cookie/Cookie.java impl/conn/tsccm/BadStaticMaps.java impl/conn/tsccm/RefQueueWorker.java impl/conn/tsccm/ThreadSafeClientConnManager.java

Author: rolandw
Date: Mon Jul 23 12:02:32 2007
New Revision: 558833

URL: http://svn.apache.org/viewvc?view=rev&rev=558833
Log:
javadoc fixes

Modified:
    jakarta/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/cookie/Cookie.java
    jakarta/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/conn/tsccm/BadStaticMaps.java
    jakarta/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/conn/tsccm/RefQueueWorker.java
    jakarta/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/conn/tsccm/ThreadSafeClientConnManager.java

Modified: jakarta/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/cookie/Cookie.java
URL: http://svn.apache.org/viewvc/jakarta/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/cookie/Cookie.java?view=diff&rev=558833&r1=558832&r2=558833
==============================================================================
--- jakarta/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/cookie/Cookie.java (original)
+++ jakarta/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/cookie/Cookie.java Mon Jul 23 12:02:32 2007
@@ -63,8 +63,6 @@
      * <tt>null</tt> if no such comment has been defined.
      * 
      * @return comment 
-     *
-     * @see #setComment(String)
      */
     String getComment();
 
@@ -75,9 +73,6 @@
      * considered immutable. Changing it (e.g. using setTime()) could result
      * in undefined behaviour. Do so at your peril. </p>
      * @return Expiration {@link Date}, or <tt>null</tt>.
-     *
-     * @see #setExpiryDate(java.util.Date)
-     *
      */
     Date getExpiryDate();
 
@@ -94,8 +89,6 @@
      * Returns domain attribute of the cookie.
      * 
      * @return the value of the domain attribute
-     *
-     * @see #setDomain(java.lang.String)
      */
     String getDomain();
 
@@ -103,14 +96,14 @@
      * Returns the path attribute of the cookie
      * 
      * @return The value of the path attribute.
-     * 
-     * @see #setPath(java.lang.String)
      */
     String getPath();
 
     /**
-     * @return <code>true</code> if this cookie should only be sent over secure connections.
-     * @see #setSecure(boolean)
+     * Indicates whether this cookie requires a secure connection.
+     *
+     * @return  <code>true</code> if this cookie should only be sent
+     *          over secure connections, <code>false</code> otherwise.
      */
     boolean isSecure();
 
@@ -119,9 +112,6 @@
      * cookie conforms.
      *
      * @return the version of the cookie.
-     * 
-     * @see #setVersion(int)
-     *
      */
     int getVersion();
 
@@ -139,8 +129,6 @@
      *
      * @return value <tt>true</tt> if the cookie's path was explicitly 
      * set, <tt>false</tt> otherwise.
-     * 
-     * @see #setPathAttributeSpecified
      */
     boolean isPathAttributeSpecified();
 
@@ -150,8 +138,6 @@
      *
      * @return value <tt>true</tt> if the cookie's domain was explicitly 
      * set, <tt>false</tt> otherwise.
-     *
-     * @see #setDomainAttributeSpecified
      */
     boolean isDomainAttributeSpecified();
 

Modified: jakarta/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/conn/tsccm/BadStaticMaps.java
URL: http://svn.apache.org/viewvc/jakarta/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/conn/tsccm/BadStaticMaps.java?view=diff&rev=558833&r1=558832&r2=558833
==============================================================================
--- jakarta/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/conn/tsccm/BadStaticMaps.java (original)
+++ jakarta/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/conn/tsccm/BadStaticMaps.java Mon Jul 23 12:02:32 2007
@@ -88,10 +88,8 @@
     /**
      * Shuts down and cleans up resources used by all instances of 
      * ThreadSafeClientConnManager. All static resources are released, all threads are 
-     * stopped, and {@link #shutdown()} is called on all live instances of 
+     * stopped, and {@link ThreadSafeClientConnManager#shutdown()} is called on all live instances of 
      * ThreadSafeClientConnManager.
-     *
-     * @see #shutdown()
      */
     static /*default*/ void shutdownAll() {
 

Modified: jakarta/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/conn/tsccm/RefQueueWorker.java
URL: http://svn.apache.org/viewvc/jakarta/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/conn/tsccm/RefQueueWorker.java?view=diff&rev=558833&r1=558832&r2=558833
==============================================================================
--- jakarta/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/conn/tsccm/RefQueueWorker.java (original)
+++ jakarta/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/conn/tsccm/RefQueueWorker.java Mon Jul 23 12:02:32 2007
@@ -40,7 +40,7 @@
 
 /**
  * A worker thread for processing queued references.
- * {@link References Reference}s can be
+ * {@link Reference Reference}s can be
  * {@link ReferenceQueue queued}
  * automatically by the garbage collector.
  * If that feature is used, a daemon thread should be executing

Modified: jakarta/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/conn/tsccm/ThreadSafeClientConnManager.java
URL: http://svn.apache.org/viewvc/jakarta/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/conn/tsccm/ThreadSafeClientConnManager.java?view=diff&rev=558833&r1=558832&r2=558833
==============================================================================
--- jakarta/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/conn/tsccm/ThreadSafeClientConnManager.java (original)
+++ jakarta/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/conn/tsccm/ThreadSafeClientConnManager.java Mon Jul 23 12:02:32 2007
@@ -406,13 +406,6 @@
     }
 
 
-    // ######################################################################
-    // ######################################################################
-    // ##########               old code below                     ##########
-    // ######################################################################
-    // ######################################################################
-
-
     /**
      * Shuts down the connection manager and releases all resources.
      * All connections associated with this manager will be closed
@@ -666,7 +659,7 @@
          * Decrements any connection counts and notifies waiting threads,
          * if appropriate.
          * 
-         * @param config        the route of the connection that was lost
+         * @param route        the route of the connection that was lost
          */
         //@@@ temporary default visibility, for BadStaticMaps
         synchronized /*default*/
@@ -816,8 +809,6 @@
          * Notifies a waiting thread that a connection is available, by route.
          *
          * @param route         the route for which to notify
-         *
-         * @see #notifyWaitingThread(RouteConnPool)
          */
         public synchronized void notifyWaitingThread(HttpRoute route) {
             notifyWaitingThread(getRoutePool(route));
@@ -1098,29 +1089,6 @@
 
     } // class TrackingPoolEntry
 
-    
-    /* *
-     * @@@ replace by separate class TSCCMConnAdapter
-     * A connection wrapper and callback handler.
-     * All connections given out by the manager are wrappers which
-     * can be {@link #detach detach}ed to prevent further use on release.
-     * /
-    private class HttpConnectionAdapter extends AbstractPooledConnAdapter {
-        //@@@ HTTPCLIENT-653
-        //@@@ this adapter being a nested class prevents proper detaching of
-        //@@@ the adapter from the manager, and therefore GC of the manager
-
-        / * *
-         * Creates a new adapter.
-         *
-         * @param entry   the pool entry for the connection being wrapped
-         * /
-        protected HttpConnectionAdapter(TrackingPoolEntry entry) {
-            super(ThreadSafeClientConnManager.this, entry);
-            super.markedReusable = true;
-        }
-    }
-    */
 
 } // class ThreadSafeClientConnManager