You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hc.apache.org by jo...@apache.org on 2010/12/12 14:29:43 UTC
svn commit: r1044820 -
/httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/HttpCacheEntry.java
Author: jonm
Date: Sun Dec 12 13:29:43 2010
New Revision: 1044820
URL: http://svn.apache.org/viewvc?rev=1044820&view=rev
Log:
HTTPCLIENT-1032: fix Javadocs on HttpCacheEntry.
Modified:
httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/client/cache/HttpCacheEntry.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=1044820&r1=1044819&r2=1044820&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 Sun Dec 12 13:29:43 2010
@@ -100,7 +100,8 @@ public class HttpCacheEntry implements S
}
/**
- * Create a new {@link HttpCacheEntry}
+ * Create a new {@link HttpCacheEntry} with a set of variant
+ * URIs.
*
* @param requestDate
* Date/time when the request was made (Used for age
@@ -109,9 +110,12 @@ public class HttpCacheEntry implements S
* Date/time that the response came back (Used for age
* calculations)
* @param statusLine
- * HTTP status line
+ * HTTP status line from origin response
* @param responseHeaders
* Header[] from original HTTP Response
+ * @param resource representing origin response body
+ * @param variants set of cache keys that are variants of this
+ * "parent" entry
*/
@Deprecated
public HttpCacheEntry(
@@ -125,12 +129,43 @@ public class HttpCacheEntry implements S
resource, variants, null);
}
+ /**
+ * Create a new {@link HttpCacheEntry}.
+ *
+ * @param requestDate
+ * Date/time when the request was made (Used for age
+ * calculations)
+ * @param responseDate
+ * Date/time that the response came back (Used for age
+ * calculations)
+ * @param statusLine
+ * HTTP status line from origin response
+ * @param responseHeaders
+ * Header[] from original HTTP Response
+ * @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,
new HashMap<String,String>());
}
+ /**
+ * Create a new {@link HttpCacheEntry} with variants.
+ * @param requestDate
+ * Date/time when the request was made (Used for age
+ * calculations)
+ * @param responseDate
+ * Date/time that the response came back (Used for age
+ * calculations)
+ * @param statusLine
+ * HTTP status line from origin response
+ * @param responseHeaders
+ * Header[] from original HTTP Response
+ * @param resource representing origin response body
+ * @param variantMap describing cache entries that are variants
+ * of this parent entry; each cache key should map to itself
+ */
public HttpCacheEntry(Date requestDate, Date responseDate,
StatusLine statusLine, Header[] headers,
Resource resource, Map<String, String> variantMap) {