hc-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From s...@apache.org
Subject svn commit: r941948 - /httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/impl/
Date Thu, 06 May 2010 21:44:24 GMT
Author: sebb
Date: Thu May  6 21:44:24 2010
New Revision: 941948

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

Modified:
    httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/impl/CachingHttpClient.java
    httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/impl/ConditionalRequestBuilder.java
    httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/impl/DefaultCacheEntrySerializer.java
    httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/impl/RequestProtocolCompliance.java
    httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/impl/ResponseCachingPolicy.java

Modified: httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/impl/CachingHttpClient.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/impl/CachingHttpClient.java?rev=941948&r1=941947&r2=941948&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/impl/CachingHttpClient.java
(original)
+++ httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/impl/CachingHttpClient.java
Thu May  6 21:44:24 2010
@@ -308,14 +308,14 @@ public class CachingHttpClient implement
     }
 
     /**
-     * @return
+     * @return the connection manager
      */
     public ClientConnectionManager getConnectionManager() {
         return backend.getConnectionManager();
     }
 
     /**
-     * @return
+     * @return the parameters
      */
     public HttpParams getParams() {
         return backend.getParams();
@@ -353,7 +353,7 @@ public class CachingHttpClient implement
      * @param request the request to execute
      * @param context the context to use for the execution, or
      *                <code>null</code> to use the default context
-     * @return
+     * @return the response
      * @throws IOException
      */
     public HttpResponse execute(HttpHost target, HttpRequest request, HttpContext context)

Modified: httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/impl/ConditionalRequestBuilder.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/impl/ConditionalRequestBuilder.java?rev=941948&r1=941947&r2=941948&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/impl/ConditionalRequestBuilder.java
(original)
+++ httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/impl/ConditionalRequestBuilder.java
Thu May  6 21:44:24 2010
@@ -42,7 +42,7 @@ public class ConditionalRequestBuilder {
      *
      * @param request
      * @param cacheEntry
-     * @return
+     * @return the wrapped request
      * @throws ProtocolException
      */
     public HttpRequest buildConditionalRequest(HttpRequest request, CacheEntry cacheEntry)

Modified: httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/impl/DefaultCacheEntrySerializer.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/impl/DefaultCacheEntrySerializer.java?rev=941948&r1=941947&r2=941948&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/impl/DefaultCacheEntrySerializer.java
(original)
+++ httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/impl/DefaultCacheEntrySerializer.java
Thu May  6 21:44:24 2010
@@ -86,7 +86,7 @@ public class DefaultCacheEntrySerializer
     /**
      *
      * @param is
-     * @return
+     * @return the cache entry
      * @throws IOException
      */
     public CacheEntry readFrom(InputStream is) throws IOException {

Modified: httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/impl/RequestProtocolCompliance.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/impl/RequestProtocolCompliance.java?rev=941948&r1=941947&r2=941948&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/impl/RequestProtocolCompliance.java
(original)
+++ httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/impl/RequestProtocolCompliance.java
Thu May  6 21:44:24 2010
@@ -53,7 +53,7 @@ public class RequestProtocolCompliance {
     /**
      *
      * @param request
-     * @return
+     * @return list of {@link RequestProtocolError}
      */
     public List<RequestProtocolError> requestIsFatallyNonCompliant(HttpRequest request)
{
         List<RequestProtocolError> theErrors = new ArrayList<RequestProtocolError>();
@@ -79,7 +79,7 @@ public class RequestProtocolCompliance {
     /**
      *
      * @param request
-     * @return
+     * @return the updated request
      * @throws ProtocolException
      */
     public HttpRequest makeRequestCompliant(HttpRequest request) throws ProtocolException
{

Modified: httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/impl/ResponseCachingPolicy.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/impl/ResponseCachingPolicy.java?rev=941948&r1=941947&r2=941948&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/impl/ResponseCachingPolicy.java
(original)
+++ httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/impl/ResponseCachingPolicy.java
Thu May  6 21:44:24 2010
@@ -61,7 +61,7 @@ public class ResponseCachingPolicy {
      *
      * @param httpMethod
      * @param response
-     * @return
+     * @return <code>true</code> if response is cacheable
      */
     public boolean isResponseCacheable(String httpMethod, HttpResponse response) {
         boolean cacheable = false;
@@ -171,7 +171,7 @@ public class ResponseCachingPolicy {
      *
      * @param request
      * @param response
-     * @return
+     * @return <code>true</code> if response is cacheable
      */
     public boolean isResponseCacheable(HttpRequest request, HttpResponse response) {
         if (requestProtocolGreaterThanAccepted(request)) {



Mime
View raw message