From 3b4b68fe683d6c8cd22faa966cc8397484418e4d Mon Sep 17 00:00:00 2001 From: Sebastian Bazley Date: Thu, 6 Jan 2011 02:57:48 +0000 Subject: [PATCH] Javadoc fixes git-svn-id: https://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk@1055723 13f79535-47bb-0310-9956-ffa450edef68 --- .../java/org/apache/http/client/cache/HttpCacheEntry.java | 8 ++++---- .../apache/http/impl/client/cache/CacheEntryUpdater.java | 2 +- .../http/impl/client/cache/CacheValidityPolicy.java | 2 +- .../client/cache/CachedResponseSuitabilityChecker.java | 4 ++-- .../http/impl/client/cache/ConditionalRequestBuilder.java | 2 +- .../java/org/apache/http/impl/client/cache/HttpCache.java | 8 ++++---- 6 files changed, 13 insertions(+), 13 deletions(-) diff --git a/httpclient-cache/src/main/java/org/apache/http/client/cache/HttpCacheEntry.java b/httpclient-cache/src/main/java/org/apache/http/client/cache/HttpCacheEntry.java index f4c930a76..ca251351e 100644 --- a/httpclient-cache/src/main/java/org/apache/http/client/cache/HttpCacheEntry.java +++ b/httpclient-cache/src/main/java/org/apache/http/client/cache/HttpCacheEntry.java @@ -145,8 +145,8 @@ public HttpCacheEntry( * @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()); } @@ -167,9 +167,9 @@ public HttpCacheEntry(Date requestDate, Date responseDate, StatusLine statusLine * 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 variantMap) { - this(requestDate, responseDate, statusLine, headers, + this(requestDate, responseDate, statusLine, responseHeaders, resource, null, variantMap); } diff --git a/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CacheEntryUpdater.java b/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CacheEntryUpdater.java index 47eb628b5..985fecd9a 100644 --- a/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CacheEntryUpdater.java +++ b/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CacheEntryUpdater.java @@ -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 diff --git a/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CacheValidityPolicy.java b/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CacheValidityPolicy.java index 5c8c60089..ea5cf40cb 100644 --- a/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CacheValidityPolicy.java +++ b/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CacheValidityPolicy.java @@ -85,7 +85,7 @@ public boolean isResponseFresh(final HttpCacheEntry entry, Date now) { * @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) { diff --git a/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CachedResponseSuitabilityChecker.java b/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CachedResponseSuitabilityChecker.java index 2a3980e31..42f6ea869 100644 --- a/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CachedResponseSuitabilityChecker.java +++ b/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CachedResponseSuitabilityChecker.java @@ -214,7 +214,7 @@ public boolean canCachedResponseBeUsed(HttpHost host, HttpRequest request, HttpC /** * 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 @@ public boolean isConditional(HttpRequest request) { * @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); diff --git a/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/ConditionalRequestBuilder.java b/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/ConditionalRequestBuilder.java index 28151ef89..5748b57e9 100644 --- a/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/ConditionalRequestBuilder.java +++ b/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/ConditionalRequestBuilder.java @@ -93,7 +93,7 @@ public HttpRequest buildConditionalRequest(HttpRequest request, HttpCacheEntry c * 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, diff --git a/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/HttpCache.java b/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/HttpCache.java index 6d8a85932..71f494240 100644 --- a/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/HttpCache.java +++ b/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/HttpCache.java @@ -70,7 +70,7 @@ void flushInvalidatedCacheEntriesFor(HttpHost host, HttpRequest request, * 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 @@ Map getVariantCacheEntriesWithEtags(HttpHost host, HttpRequest r * @param originResponse * @param requestSent * @param responseReceived - * @return + * @return the {@link HttpResponse} * @throws IOException */ HttpResponse cacheAndReturnResponse( @@ -110,7 +110,7 @@ HttpResponse cacheAndReturnResponse( * @param originResponse * @param requestSent * @param responseReceived - * @return + * @return the updated {@link HttpCacheEntry} * @throws IOException */ HttpCacheEntry updateCacheEntry( @@ -128,7 +128,7 @@ HttpCacheEntry updateCacheEntry( * @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,