com.apollographql.apollo.cache.normalized

Enum CacheControl

java.lang.Object

java.lang.Enum<CacheControl>

com.apollographql.apollo.cache.normalized.CacheControl

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CacheControl>

public enum CacheControl
extends java.lang.Enum<CacheControl>

CacheControl represents strategies for what order a NormalizedCache will be accessed with respect to the network. To control how a cache reads and writes a response to the cache, see CacheHeaders.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CACHE_FIRST Signals the apollo client to first fetch the data from the normalized cache.
CACHE_ONLY Signals the apollo client to only fetch the data from the normalized cache.
NETWORK_FIRST Signals the apollo client to first fetch the data from the network.
NETWORK_ONLY Signals the apollo client to only fetch the GraphQL data from the network.

Method Summary

Modifier and Type	Method and Description
static CacheControl	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CacheControl[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CACHE_FIRST

public static final CacheControl CACHE_FIRST

Signals the apollo client to first fetch the data from the normalized cache. If it's not present in the normalized cache or if an exception occurs while trying to fetch it from the normalized cache, then the data is instead fetched from the network.

CACHE_ONLY

public static final CacheControl CACHE_ONLY

Signals the apollo client to only fetch the data from the normalized cache. If it's not present in the normalized cache or if an exception occurs while trying to fetch it from the normalized cache, an empty Response is sent back with the Operation info wrapped inside.

NETWORK_FIRST

public static final CacheControl NETWORK_FIRST

Signals the apollo client to first fetch the data from the network. If network request fails, then the data is fetched from the normalized cache. If the data is not present in the normalized cache, then the exception which led to the network request failure is rethrown.

NETWORK_ONLY

public static final CacheControl NETWORK_ONLY

Signals the apollo client to only fetch the GraphQL data from the network. If network request fails, an exception is thrown.

Method Detail

values

public static CacheControl[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CacheControl c : CacheControl.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CacheControl valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null