CacheControl (OkHttp 3.12.13 API)

java.lang.Object
- okhttp3.CacheControl

```
public final class CacheControl
extends Object
```
A Cache-Control header with cache directives from a server or client. These directives set policy on what responses can be stored, and which requests can be satisfied by those stored responses.
See RFC 7234, 5.2.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class CacheControl.Builder
Builds a Cache-Control request header.

Nested Classes
Modifier and Type	Class	Description
`static class`	`CacheControl.Builder`	Builds a `Cache-Control` request header.

Field Summary

Fields
Modifier and Type	Field	Description
`static CacheControl`	`FORCE_CACHE`	Cache control request directives that uses the cache only, even if the cached response is stale.
`static CacheControl`	`FORCE_NETWORK`	Cache control request directives that require network validation of responses.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`immutable()`
`boolean`	`isPrivate()`
`boolean`	`isPublic()`
`int`	`maxAgeSeconds()`	The duration past the response's served date that it can be served without validation.
`int`	`maxStaleSeconds()`
`int`	`minFreshSeconds()`
`boolean`	`mustRevalidate()`
`boolean`	`noCache()`	In a response, this field's name "no-cache" is misleading.
`boolean`	`noStore()`	If true, this response should not be cached.
`boolean`	`noTransform()`
`boolean`	`onlyIfCached()`	This field's name "only-if-cached" is misleading.
`static CacheControl`	`parse(Headers headers)`	Returns the cache directives of `headers`.
`int`	`sMaxAgeSeconds()`	The "s-maxage" directive is the max age for shared caches.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - FORCE_NETWORK
```
public static final CacheControl FORCE_NETWORK
```
    Cache control request directives that require network validation of responses. Note that such requests may be assisted by the cache via conditional GET requests.
  - FORCE_CACHE
```
public static final CacheControl FORCE_CACHE
```
    Cache control request directives that uses the cache only, even if the cached response is stale. If the response isn't available in the cache or requires server validation, the call will fail with a 504 Unsatisfiable Request.
- Method Detail
  - noCache
```
public boolean noCache()
```
    In a response, this field's name "no-cache" is misleading. It doesn't prevent us from caching the response; it only means we have to validate the response with the origin server before returning it. We can do this with a conditional GET.
    In a request, it means do not use a cache to satisfy the request.
  - noStore
```
public boolean noStore()
```
    If true, this response should not be cached.
  - maxAgeSeconds
```
public int maxAgeSeconds()
```
    The duration past the response's served date that it can be served without validation.
  - sMaxAgeSeconds
```
public int sMaxAgeSeconds()
```
    The "s-maxage" directive is the max age for shared caches. Not to be confused with "max-age" for non-shared caches, As in Firefox and Chrome, this directive is not honored by this cache.
  - isPrivate
```
public boolean isPrivate()
```
  - isPublic
```
public boolean isPublic()
```
  - mustRevalidate
```
public boolean mustRevalidate()
```
  - maxStaleSeconds
```
public int maxStaleSeconds()
```
  - minFreshSeconds
```
public int minFreshSeconds()
```
  - onlyIfCached
```
public boolean onlyIfCached()
```
    This field's name "only-if-cached" is misleading. It actually means "do not use the network". It is set by a client who only wants to make a request if it can be fully satisfied by the cache. Cached responses that would require validation (ie. conditional gets) are not permitted if this header is set.
  - noTransform
```
public boolean noTransform()
```
  - immutable
```
public boolean immutable()
```
  - parse
```
public static CacheControl parse(Headers headers)
```
    Returns the cache directives of headers. This honors both Cache-Control and Pragma headers if they are present.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class CacheControl

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FORCE_NETWORK

FORCE_CACHE

Method Detail

noCache

noStore

maxAgeSeconds

sMaxAgeSeconds

isPrivate

isPublic

mustRevalidate

maxStaleSeconds

minFreshSeconds

onlyIfCached

noTransform

immutable

parse

toString