All Classes and Interfaces
Class
Description
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 the
DataLoader
code to
provide overall calling context to the BatchLoader
call.This object is passed to a batch loader as calling context.
A BatchLoaderEnvironmentProvider is used by the
DataLoader
code to
provide BatchLoaderEnvironment
calling context to
the BatchLoader
call.By default, when
DataLoader.dispatch()
is called, the BatchLoader
/ MappedBatchLoader
function will be invoked
immediately.This represents a callback that will invoke a
BatchLoader
function under the coversThis represents a callback that will invoke a
BatchPublisher
or MappedBatchPublisher
function under the coversThis represents a callback that will invoke a
MappedBatchLoader
function under the coversThis form of
BatchLoader
is given a BatchLoaderEnvironment
object
that encapsulates the calling context.A function that is invoked for batch loading a stream of data values indicated by the provided list of keys.
This form of
BatchPublisher
is given a BatchLoaderEnvironment
object
that encapsulates the calling context.Function that is invoked on input keys of type
K
to derive keys that are required by the CacheMap
implementation.CacheMap is used by data loaders that use caching promises to values aka
CompletableFuture
<V>.This
DataLoaderInstrumentation
can chain together multiple instrumentations and have them all called in
the order of the provided list.Some really basic helpers when working with CompletableFutures
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 create
DataLoader
sA builder of
DataLoader
sThis interface is called when certain actions happen inside a data loader
When a
DataLoaderInstrumentation
.'beginXXX()' method is called then it must return a DataLoaderInstrumentationContext
that will be invoked when the step is first dispatched and then when it completes.Configuration options for
DataLoader
instances.This allows data loaders to be registered together into a single place, so
they can be dispatched as one.
This delegating
DataLoader
makes it easier to create wrappers of DataLoader
s in case you want to change how
values are returned for example.This statistics collector keeps dataloader statistics AND also calls the delegate
collector at the same time.
A predicate class used by
ScheduledDataLoaderRegistry
to decide whether to dispatch or notWhen a DataLoader is dispatched this object holds the promised results and also the count of key asked for
via methods like
DataLoader.load(Object)
or DataLoader.loadMany(java.util.List)
This represents code that the graphql-java project considers experimental API and while our intention is that it will
progress to be
PublicApi
, its existence, signature of behavior may change between releases.Indicates that the annotated element should be used only while holding the specified lock.
This represents code that the java-dataloader project considers internal code that MAY not be stable within
major releases.
A function that is invoked for batch loading a map of data values indicated by the provided set of keys.
This form of
MappedBatchLoader
is given a BatchLoaderEnvironment
object
that encapsulates the calling context.A function that is invoked for batch loading a stream of data values indicated by the provided list of keys.
This form of
MappedBatchPublisher
is given a BatchLoaderEnvironment
object
that encapsulates the calling context.A statistics collector that does nothing
Implementation of
ValueCache
that does nothing.This allows multiple
CompletionStage
s to be combined and completed
as one and should something go wrong, instead of throwing CompletionException
s it captures the cause and returns null for that
data value, otherwise it allows you to access them as a list of values.This represents code that the java-dataloader project considers public API and has an imperative to be stable within
major releases.
This represents code that the java-dataloader project considers public SPI and has an imperative to be stable within
major releases.
Just some callbacks to the data loader code to do common tasks
This
DataLoaderRegistry
will use DispatchPredicate
s when ScheduledDataLoaderRegistry.dispatchAll()
is called
to test (for each DataLoader
in the registry) if a dispatch should proceed.This simple collector uses
AtomicLong
s to collect
statisticsThis holds statistics on how a
DataLoader
has performedThis allows statistics to be collected for
DataLoader
operationsThis can collect statistics per thread as well as in an overall sense.
Try is class that allows you to hold the result of computation or the throwable it produced.
The
ValueCache
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 method
Options that control how the
ValueCache
is used by DataLoader
Marks fields, methods etc.