Store/cache/README.md
2017-05-23 18:15:13 -04:00

1.6 KiB

Cache

Store depends on a subset of Guava, we have extracted these parts into a shaded Cache artifact.
Feel free to use Cache anytime you need an in memory cache implementation optimized for Android.

To use, first build a cache instance.

 memCache = CacheBuilder.newBuilder()
                .maximumSize(getCacheSize())
                .expireAfterAccess(getCacheTTL(), TimeUnit.SECONDS)
                .build();

You can then use your cache as regular cache or one that knows how to load itself (with blocking) when empty

memCache.get(key, new Callable<T>() {
                @Override
                public Observable<T> call() throws Exception {
                    return getCachedValue(key);
                }
            });

Please refer to Guava's Cache documentation for additional features/configurations https://github.com/google/guava/wiki/CachesExplained

	compile 'com.nytimes.android:cache3:3.0.0-alpha'
Copyright (c) 2017 The New York Times Company

Copyright (c) 2010 The Guava Authors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this library except in 
compliance with the License. You may obtain a copy of the License at

www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an 
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific 
language governing permissions and limitations under the License.