Apache
/
httpcomponents-client
mirror of https://github.com/apache/httpcomponents-client.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

HTTPCLIENT-1032: fix Javadocs on HttpCacheEntry. 

git-svn-id: https://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk@1044820 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Jonathan Moore 2010-12-12 13:29:43 +00:00
parent e025613aab
commit 2c04f2689b
1 changed files with 37 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
httpclient-cache/src/main/java/org/apache/http/client/cache/HttpCacheEntry.java vendored
View File

@ -100,7 +100,8 @@ public class HttpCacheEntry implements Serializable {
} }
/** /**
* Create a new {@link HttpCacheEntry} * Create a new {@link HttpCacheEntry} with a set of variant
* URIs.
* *
* @param requestDate * @param requestDate
* Date/time when the request was made (Used for age * Date/time when the request was made (Used for age
@ -109,9 +110,12 @@ public class HttpCacheEntry implements Serializable {
* Date/time that the response came back (Used for age * Date/time that the response came back (Used for age
* calculations) * calculations)
* @param statusLine * @param statusLine
* HTTP status line * HTTP status line from origin response
* @param responseHeaders * @param responseHeaders
* Header[] from original HTTP Response * 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 @Deprecated
public HttpCacheEntry( public HttpCacheEntry(
@ -125,12 +129,43 @@ public class HttpCacheEntry implements Serializable {
resource, variants, null); 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, public HttpCacheEntry(Date requestDate, Date responseDate, StatusLine statusLine,
Header[] headers, Resource resource) { Header[] headers, Resource resource) {
this(requestDate, responseDate, statusLine, headers, resource, null, this(requestDate, responseDate, statusLine, headers, resource, null,
new HashMap<String,String>()); 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, public HttpCacheEntry(Date requestDate, Date responseDate,
StatusLine statusLine, Header[] headers, StatusLine statusLine, Header[] headers,
Resource resource, Map<String, String> variantMap) { Resource resource, Map<String, String> variantMap) {