Package org.dataloader
package org.dataloader
-
ClassDescriptionBatchLoader<K,
V extends @Nullable Object> A function that is invoked for batch loading a list of data values indicated by the provided list of keys.A BatchLoaderContextProvider is used by theDataLoader
code to provide overall calling context to theBatchLoader
call.This object is passed to a batch loader as calling context.A BatchLoaderEnvironmentProvider is used by theDataLoader
code to provideBatchLoaderEnvironment
calling context to theBatchLoader
call.BatchLoaderWithContext<K,V extends @Nullable Object> 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.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>.DataLoader<K,V extends @Nullable Object> Data loader is a utility class that allows batch loading of data that is identified by a set of unique keys.A factory class to createDataLoader
sA builder ofDataLoader
sConfiguration options forDataLoader
instances.This allows data loaders to be registered together into a single place, so they can be dispatched as one.DelegatingDataLoader<K,V> This delegatingDataLoader
makes it easier to create wrappers ofDataLoader
s in case you want to change how values are returned for example.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)
MappedBatchLoader<K,V extends @Nullable Object> A function that is invoked for batch loading a map of data values indicated by the provided set of keys.MappedBatchLoaderWithContext<K,V extends @Nullable Object> This form ofMappedBatchLoader
is given aBatchLoaderEnvironment
object that encapsulates the calling context.MappedBatchPublisher<K,V extends @Nullable Object> A function that is invoked for batch loading a stream of data values indicated by the provided list of keys.MappedBatchPublisherWithContext<K,V extends @Nullable Object> This form ofMappedBatchPublisher
is given aBatchLoaderEnvironment
object that encapsulates the calling context.Try<V>Try is class that allows you to hold the result of computation or the throwable it produced.ValueCache<K,V extends @Nullable Object> TheValueCache
is used by data loaders that use caching and want a long-lived or external cache of values.This special exception can be used to short-circuit a caching methodOptions that control how theValueCache
is used byDataLoader