You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hc.apache.org by se...@apache.org on 2011/01/06 03:57:48 UTC
svn commit: r1055723 - in
/httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http:
client/cache/ impl/client/cache/
Author: sebb
Date: Thu Jan 6 02:57:48 2011
New Revision: 1055723
URL: http://svn.apache.org/viewvc?rev=1055723&view=rev
Log:
Javadoc fixes
Modified:
httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/HttpCacheEntry.java
httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CacheEntryUpdater.java
httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CacheValidityPolicy.java
httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CachedResponseSuitabilityChecker.java
httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/ConditionalRequestBuilder.java
httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/HttpCache.java
Modified: httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/HttpCacheEntry.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/HttpCacheEntry.java?rev=1055723&r1=1055722&r2=1055723&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/HttpCacheEntry.java (original)
+++ httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/HttpCacheEntry.java Thu Jan 6 02:57:48 2011
@@ -145,8 +145,8 @@ public class HttpCacheEntry implements S
* @param resource representing origin response body
*/
public HttpCacheEntry(Date requestDate, Date responseDate, StatusLine statusLine,
- Header[] headers, Resource resource) {
- this(requestDate, responseDate, statusLine, headers, resource, null,
+ Header[] responseHeaders, Resource resource) {
+ this(requestDate, responseDate, statusLine, responseHeaders, resource, null,
new HashMap<String,String>());
}
@@ -167,9 +167,9 @@ public class HttpCacheEntry implements S
* of this parent entry; each cache key should map to itself
*/
public HttpCacheEntry(Date requestDate, Date responseDate,
- StatusLine statusLine, Header[] headers,
+ StatusLine statusLine, Header[] responseHeaders,
Resource resource, Map<String, String> variantMap) {
- this(requestDate, responseDate, statusLine, headers,
+ this(requestDate, responseDate, statusLine, responseHeaders,
resource, null, variantMap);
}
Modified: httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CacheEntryUpdater.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CacheEntryUpdater.java?rev=1055723&r1=1055722&r2=1055723&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CacheEntryUpdater.java (original)
+++ httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CacheEntryUpdater.java Thu Jan 6 02:57:48 2011
@@ -70,7 +70,7 @@ class CacheEntryUpdater {
* Update the entry with the new information from the response. Should only be used for
* 304 responses.
*
- * @param request id
+ * @param requestId
* @param entry The cache Entry to be updated
* @param requestDate When the request was performed
* @param responseDate When the response was gotten
Modified: httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CacheValidityPolicy.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CacheValidityPolicy.java?rev=1055723&r1=1055722&r2=1055723&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CacheValidityPolicy.java (original)
+++ httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CacheValidityPolicy.java Thu Jan 6 02:57:48 2011
@@ -85,7 +85,7 @@ class CacheValidityPolicy {
* @param now
* @param coefficient
* @param defaultLifetime
- * @return
+ * @return {@code true} if the response is fresh
*/
public boolean isResponseHeuristicallyFresh(final HttpCacheEntry entry,
Date now, float coefficient, long defaultLifetime) {
Modified: httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CachedResponseSuitabilityChecker.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CachedResponseSuitabilityChecker.java?rev=1055723&r1=1055722&r2=1055723&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CachedResponseSuitabilityChecker.java (original)
+++ httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CachedResponseSuitabilityChecker.java Thu Jan 6 02:57:48 2011
@@ -214,7 +214,7 @@ class CachedResponseSuitabilityChecker {
/**
* Is this request the type of conditional request we support?
* @param request
- * @return
+ * @return {@code true} if the request is supported
*/
public boolean isConditional(HttpRequest request) {
return hasSupportedEtagVadlidator(request) || hasSupportedLastModifiedValidator(request);
@@ -225,7 +225,7 @@ class CachedResponseSuitabilityChecker {
* @param request
* @param entry
* @param now
- * @return
+ * @return {@code true} if the request matches all conditionals
*/
public boolean allConditionalsMatch(HttpRequest request, HttpCacheEntry entry, Date now) {
boolean hasEtagValidator = hasSupportedEtagVadlidator(request);
Modified: httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/ConditionalRequestBuilder.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/ConditionalRequestBuilder.java?rev=1055723&r1=1055722&r2=1055723&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/ConditionalRequestBuilder.java (original)
+++ httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/ConditionalRequestBuilder.java Thu Jan 6 02:57:48 2011
@@ -93,7 +93,7 @@ class ConditionalRequestBuilder {
* exist, the request is unmodified
*
* @param request the original request from the caller
- * @param cacheEntry the entry that needs to be revalidated
+ * @param variants
* @return the wrapped request
*/
public HttpRequest buildConditionalRequestFromVariants(HttpRequest request,
Modified: httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/HttpCache.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/HttpCache.java?rev=1055723&r1=1055722&r2=1055723&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/HttpCache.java (original)
+++ httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/HttpCache.java Thu Jan 6 02:57:48 2011
@@ -70,7 +70,7 @@ interface HttpCache {
* Retrieve matching {@link HttpCacheEntry} from the cache if it exists
* @param host
* @param request
- * @return
+ * @return the matching {@link HttpCacheEntry} or {@code null}
* @throws IOException
*/
HttpCacheEntry getCacheEntry(HttpHost host, HttpRequest request)
@@ -94,7 +94,7 @@ interface HttpCache {
* @param originResponse
* @param requestSent
* @param responseReceived
- * @return
+ * @return the {@link HttpResponse}
* @throws IOException
*/
HttpResponse cacheAndReturnResponse(
@@ -110,7 +110,7 @@ interface HttpCache {
* @param originResponse
* @param requestSent
* @param responseReceived
- * @return
+ * @return the updated {@link HttpCacheEntry}
* @throws IOException
*/
HttpCacheEntry updateCacheEntry(
@@ -128,7 +128,7 @@ interface HttpCache {
* @param requestSent when the validating request was sent
* @param responseReceived when the validating response was received
* @param cacheKey where in the cache this entry is currently stored
- * @return
+ * @return the updated {@link HttpCacheEntry}
* @throws IOException
*/
HttpCacheEntry updateVariantCacheEntry(HttpHost target, HttpRequest request,