Package org.dataloader
-
Interface Summary Interface Description BatchLoader<K,V> A function that is invoked for batch loading a list of data values indicated by the provided list of keys.BatchLoaderContextProvider A BatchLoaderContextProvider is used by theDataLoader
code to provide overall calling context to theBatchLoader
call.BatchLoaderEnvironmentProvider A BatchLoaderEnvironmentProvider is used by theDataLoader
code to provideBatchLoaderEnvironment
calling context to theBatchLoader
call.BatchLoaderWithContext<K,V> This form ofBatchLoader
is given aBatchLoaderEnvironment
object that encapsulates the calling context.BatchPublisher<K,V> A function that is invoked for batch loading a stream of data values indicated by the provided list of keys.BatchPublisherWithContext<K,V> This form ofBatchPublisher
is given aBatchLoaderEnvironment
object that encapsulates the calling context.CacheKey<K> Function that is invoked on input keys of typeK
to derive keys that are required by theCacheMap
implementation.CacheMap<K,V> CacheMap is used by data loaders that use caching promises to values akaCompletableFuture
<V>.MappedBatchLoader<K,V> A function that is invoked for batch loading a map of data values indicated by the provided set of keys.MappedBatchLoaderWithContext<K,V> This form ofMappedBatchLoader
is given aBatchLoaderEnvironment
object that encapsulates the calling context.MappedBatchPublisher<K,V> A function that is invoked for batch loading a stream of data values indicated by the provided list of keys.MappedBatchPublisherWithContext<K,V> This form ofMappedBatchPublisher
is given aBatchLoaderEnvironment
object that encapsulates the calling context.ValueCache<K,V> TheValueCache
is used by data loaders that use caching and want a long-lived or external cache of values. -
Class Summary Class Description BatchLoaderEnvironment This object is passed to a batch loader as calling context.BatchLoaderEnvironment.Builder DataLoader<K,V> Data loader is a utility class that allows batch loading of data that is identified by a set of unique keys.DataLoaderFactory A factory class to createDataLoader
sDataLoaderOptions Configuration options forDataLoader
instances.DataLoaderRegistry This allows data loaders to be registered together into a single place, so they can be dispatched as one.DataLoaderRegistry.Builder DispatchResult<T> When a DataLoader is dispatched this object holds the promised results and also the count of key asked for via methods likeDataLoader.load(Object)
orDataLoader.loadMany(java.util.List)
Try<V> Try is class that allows you to hold the result of computation or the throwable it produced.ValueCacheOptions Options that control how theValueCache
is used byDataLoader
-
Exception Summary Exception Description ValueCache.ValueCachingNotSupported This special exception can be used to short-circuit a caching method