forked from graphql-java/java-dataloader
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathCacheMap.java
More file actions
108 lines (97 loc) · 3.69 KB
/
CacheMap.java
File metadata and controls
108 lines (97 loc) · 3.69 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
/*
* Copyright (c) 2016 The original author or authors
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* and Apache License v2.0 which accompanies this distribution.
*
* The Eclipse Public License is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* The Apache License v2.0 is available at
* http://www.opensource.org/licenses/apache2.0.php
*
* You may elect to redistribute this code under either of these licenses.
*/
package org.dataloader;
import org.dataloader.annotations.PublicSpi;
import org.dataloader.impl.DefaultCacheMap;
import java.util.Collection;
import java.util.concurrent.CompletableFuture;
/**
* CacheMap is used by data loaders that use caching promises to values aka {@link CompletableFuture}<V>. A better name for this
* class might have been FutureCache but that is history now.
* <p>
* The default implementation used by the data loader is based on a {@link java.util.LinkedHashMap}.
* <p>
* This is really a cache of completed {@link CompletableFuture}<V> values in memory. It is used, when caching is enabled, to
* give back the same future to any code that may call it. If you need a cache of the underlying values that is possible external to the JVM
* then you will want to use {{@link ValueCache}} which is designed for external cache access.
*
* @param <K> type parameter indicating the type of the cache keys
* @param <V> type parameter indicating the type of the data that is cached
*
* @author <a href="https://github.com/aschrijver/">Arnold Schrijver</a>
* @author <a href="https://github.com/bbakerman/">Brad Baker</a>
*/
@PublicSpi
public interface CacheMap<K, V> {
/**
* Creates a new cache map, using the default implementation that is based on a {@link java.util.LinkedHashMap}.
*
* @param <K> type parameter indicating the type of the cache keys
* @param <V> type parameter indicating the type of the data that is cached
*
* @return the cache map
*/
static <K, V> CacheMap<K, V> simpleMap() {
return new DefaultCacheMap<>();
}
/**
* Checks whether the specified key is contained in the cache map.
*
* @param key the key to check
*
* @return {@code true} if the cache contains the key, {@code false} otherwise
*/
boolean containsKey(K key);
/**
* Gets the specified key from the cache map.
* <p>
* May throw an exception if the key does not exist, depending on the cache map implementation that is used,
* so be sure to check {@link CacheMap#containsKey(Object)} first.
*
* @param key the key to retrieve
*
* @return the cached value, or {@code null} if not found (depends on cache implementation)
*/
CompletableFuture<V> get(K key);
/**
* Gets a collection of CompletableFutures from the cache map.
* @return the collection of cached values
*/
Collection<CompletableFuture<V>> getAll();
/**
* Creates a new cache map entry with the specified key and value, or updates the value if the key already exists.
*
* @param key the key to cache
* @param value the value to cache
*
* @return the cache map for fluent coding
*/
CacheMap<K, V> set(K key, CompletableFuture<V> value);
/**
* Deletes the entry with the specified key from the cache map, if it exists.
*
* @param key the key to delete
*
* @return the cache map for fluent coding
*/
CacheMap<K, V> delete(K key);
/**
* Clears all entries of the cache map
*
* @return the cache map for fluent coding
*/
CacheMap<K, V> clear();
}