Index
All Classes and Interfaces|All Packages|Serialized Form
A
- allOf(CompletionStage<T>, CompletionStage<T>) - Static method in interface org.dataloader.impl.PromisedValues
-
Returns a new
PromisedValues
that is completed when all of the givenCompletionStage
s complete. - allOf(CompletionStage<T>, CompletionStage<T>, CompletionStage<T>) - Static method in interface org.dataloader.impl.PromisedValues
-
Returns a new
PromisedValues
that is completed when all of the givenCompletionStage
s complete. - allOf(CompletionStage<T>, CompletionStage<T>, CompletionStage<T>, CompletionStage<T>) - Static method in interface org.dataloader.impl.PromisedValues
-
Returns a new
PromisedValues
that is completed when all of the givenCompletionStage
s complete. - allOf(List<? extends CompletionStage<T>>) - Static method in interface org.dataloader.impl.PromisedValues
-
Returns a new
PromisedValues
that is completed when all of the givenCompletionStage
s complete. - allOf(List<CompletableFuture<T>>) - Static method in class org.dataloader.impl.CompletableFutureKit
- allPromisedValues(List<PromisedValues<T>>) - Static method in interface org.dataloader.impl.PromisedValues
-
Returns a new
PromisedValues
that is completed when all of the givenPromisedValues
s complete. - allPromisedValues(PromisedValues<T>, PromisedValues<T>) - Static method in interface org.dataloader.impl.PromisedValues
-
Returns a new
PromisedValues
that is completed when all of the givenPromisedValues
s complete. - allPromisedValues(PromisedValues<T>, PromisedValues<T>, PromisedValues<T>) - Static method in interface org.dataloader.impl.PromisedValues
-
Returns a new
PromisedValues
that is completed when all of the givenPromisedValues
s complete. - allPromisedValues(PromisedValues<T>, PromisedValues<T>, PromisedValues<T>, PromisedValues<T>) - Static method in interface org.dataloader.impl.PromisedValues
-
Returns a new
PromisedValues
that is completed when all of the givenPromisedValues
s complete. - ALWAYS_FAILED - Variable in class org.dataloader.DataLoaderHelper
- alwaysFailed() - Static method in class org.dataloader.Try
-
This returns a Try that has always failed with an consistent exception.
- and(DispatchPredicate) - Method in interface org.dataloader.registries.DispatchPredicate
-
Returns a composed predicate that represents a short-circuiting logical AND of this predicate and another.
- Assertions - Class in org.dataloader.impl
- Assertions() - Constructor for class org.dataloader.impl.Assertions
- assertResultSize(List<K>, List<V>) - Method in class org.dataloader.DataLoaderHelper
- assertState(boolean, Supplier<String>) - Static method in class org.dataloader.impl.Assertions
B
- batchingEnabled - Variable in class org.dataloader.DataLoaderOptions
- batchingEnabled() - Method in class org.dataloader.DataLoaderOptions
-
Option that determines whether to use batching (the default), or not.
- batchInvokeCount - Variable in class org.dataloader.stats.SimpleStatisticsCollector
- batchInvokeCount - Variable in class org.dataloader.stats.Statistics
- batchLoadCount - Variable in class org.dataloader.stats.SimpleStatisticsCollector
- batchLoadCount - Variable in class org.dataloader.stats.Statistics
- BatchLoader<K,
V> - Interface in org.dataloader -
A function that is invoked for batch loading a list of data values indicated by the provided list of keys.
- BatchLoaderContextProvider - Interface in org.dataloader
-
A BatchLoaderContextProvider is used by the
DataLoader
code to provide overall calling context to theBatchLoader
call. - BatchLoaderEnvironment - Class in org.dataloader
-
This object is passed to a batch loader as calling context.
- BatchLoaderEnvironment(Object, List<Object>, Map<Object, Object>) - Constructor for class org.dataloader.BatchLoaderEnvironment
- BatchLoaderEnvironment.Builder - Class in org.dataloader
- BatchLoaderEnvironmentProvider - Interface in org.dataloader
-
A BatchLoaderEnvironmentProvider is used by the
DataLoader
code to provideBatchLoaderEnvironment
calling context to theBatchLoader
call. - BatchLoaderWithContext<K,
V> - Interface in org.dataloader -
This form of
BatchLoader
is given aBatchLoaderEnvironment
object that encapsulates the calling context. - batchLoadExceptionCount - Variable in class org.dataloader.stats.SimpleStatisticsCollector
- batchLoadExceptionCount - Variable in class org.dataloader.stats.Statistics
- batchLoadFunction - Variable in class org.dataloader.DataLoaderHelper
- build() - Method in class org.dataloader.BatchLoaderEnvironment.Builder
- build() - Method in class org.dataloader.DataLoaderRegistry.Builder
- build() - Method in class org.dataloader.registries.ScheduledDataLoaderRegistry.Builder
- Builder() - Constructor for class org.dataloader.BatchLoaderEnvironment.Builder
- Builder() - Constructor for class org.dataloader.DataLoaderRegistry.Builder
- Builder() - Constructor for class org.dataloader.registries.ScheduledDataLoaderRegistry.Builder
C
- cache - Variable in class org.dataloader.impl.DefaultCacheMap
- cacheHitCount - Variable in class org.dataloader.stats.SimpleStatisticsCollector
- cacheHitCount - Variable in class org.dataloader.stats.Statistics
- CacheKey<K> - Interface in org.dataloader
-
Function that is invoked on input keys of type
K
to derive keys that are required by theCacheMap
implementation. - cacheKeyFunction - Variable in class org.dataloader.DataLoaderOptions
- cacheKeyFunction() - Method in class org.dataloader.DataLoaderOptions
-
Gets an (optional) function to invoke for creation of the cache key, if caching is enabled.
- cacheMap - Variable in class org.dataloader.DataLoaderOptions
- cacheMap() - Method in class org.dataloader.DataLoaderOptions
-
Gets the (optional) cache map implementation that is used for caching, if caching is enabled.
- CacheMap<K,
V> - Interface in org.dataloader -
CacheMap is used by data loaders that use caching promises to values aka
CompletableFuture
<V>. - cachingEnabled - Variable in class org.dataloader.DataLoaderOptions
- cachingEnabled() - Method in class org.dataloader.DataLoaderOptions
-
Option that determines whether to use caching of futures (the default), or not.
- cachingExceptionsEnabled - Variable in class org.dataloader.DataLoaderOptions
- cachingExceptionsEnabled() - Method in class org.dataloader.DataLoaderOptions
-
Option that determines whether to cache exceptional values (the default), or not.
- callContext - Variable in class org.dataloader.DataLoaderHelper.LoaderQueueEntry
- callContext - Variable in class org.dataloader.stats.context.IncrementCacheHitCountStatisticsContext
- callContext - Variable in class org.dataloader.stats.context.IncrementLoadCountStatisticsContext
- callContext - Variable in class org.dataloader.stats.context.IncrementLoadErrorCountStatisticsContext
- callContexts - Variable in class org.dataloader.stats.context.IncrementBatchLoadCountByStatisticsContext
- callContexts - Variable in class org.dataloader.stats.context.IncrementBatchLoadExceptionCountStatisticsContext
- cause - Variable in class org.dataloader.impl.PromisedValuesImpl
- cause() - Method in interface org.dataloader.impl.PromisedValues
-
The exception cause or null if it didn't fail
- cause() - Method in class org.dataloader.impl.PromisedValuesImpl
- cause(int) - Method in interface org.dataloader.impl.PromisedValues
-
The exception cause at the specified index or null if it didn't fail
- cause(int) - Method in class org.dataloader.impl.PromisedValuesImpl
- cause(CompletableFuture<V>) - Static method in class org.dataloader.impl.CompletableFutureKit
- clear() - Method in interface org.dataloader.CacheMap
-
Clears all entries of the cache map
- clear() - Method in class org.dataloader.impl.DefaultCacheMap
-
Clears all entries of the cache map
- clear() - Method in class org.dataloader.impl.NoOpValueCache
-
Clears all entries from the value cache.
- clear() - Method in interface org.dataloader.ValueCache
-
Clears all entries from the value cache.
- clear(K) - Method in class org.dataloader.DataLoader
-
Clears the future with the specified key from the cache, if caching is enabled, so it will be re-fetched on the next load request.
- clear(K, BiConsumer<Void, Throwable>) - Method in class org.dataloader.DataLoader
-
Clears the future with the specified key from the cache remote value store, if caching is enabled and a remote store is set, so it will be re-fetched and stored on the next load request.
- clearAll() - Method in class org.dataloader.DataLoader
-
Clears the entire cache map of the loader.
- clearAll(BiConsumer<Void, Throwable>) - Method in class org.dataloader.DataLoader
-
Clears the entire cache map of the loader, and of the cached value store.
- clock - Variable in class org.dataloader.DataLoaderHelper
- close() - Method in class org.dataloader.registries.ScheduledDataLoaderRegistry
-
Once closed this registry will never again reschedule checks
- closed - Variable in class org.dataloader.registries.ScheduledDataLoaderRegistry
- collector - Variable in class org.dataloader.stats.DelegatingStatisticsCollector
- collector - Static variable in class org.dataloader.stats.ThreadLocalStatisticsCollector
- combine(DataLoaderRegistry) - Method in class org.dataloader.DataLoaderRegistry
-
This will combine all the current data loaders in this registry and all the data loaders from the specified registry and return a new combined registry
- combine(Statistics) - Method in class org.dataloader.stats.Statistics
-
This will combine this set of statistics with another set of statistics so that they become the combined count of each
- combineAllOf(List<? extends CompletionStage<T>>) - Static method in class org.dataloader.impl.PromisedValuesImpl
- combinePromisedValues(List<PromisedValues<T>>) - Static method in class org.dataloader.impl.PromisedValuesImpl
- CompletableFutureKit - Class in org.dataloader.impl
-
Some really basic helpers when working with CompletableFutures
- CompletableFutureKit() - Constructor for class org.dataloader.impl.CompletableFutureKit
- completeValueAfterCacheSet - Variable in class org.dataloader.ValueCacheOptions
- computeIfAbsent(String, Function<String, DataLoader<?, ?>>) - Method in class org.dataloader.DataLoaderRegistry
-
Computes a data loader if absent or return it if it was already registered at that key.
- containsKey(K) - Method in interface org.dataloader.CacheMap
-
Checks whether the specified key is contained in the cache map.
- containsKey(K) - Method in class org.dataloader.impl.DefaultCacheMap
-
Checks whether the specified key is contained in the cache map.
- context - Variable in class org.dataloader.BatchLoaderEnvironment.Builder
- context - Variable in class org.dataloader.BatchLoaderEnvironment
- context(Object) - Method in class org.dataloader.BatchLoaderEnvironment.Builder
- controller - Variable in class org.dataloader.impl.PromisedValuesImpl
D
- dataLoader - Variable in class org.dataloader.DataLoaderHelper
- DataLoader<K,
V> - Class in org.dataloader -
Data loader is a utility class that allows batch loading of data that is identified by a set of unique keys.
- DataLoader(Object, DataLoaderOptions) - Constructor for class org.dataloader.DataLoader
- DataLoader(Object, DataLoaderOptions, Clock) - Constructor for class org.dataloader.DataLoader
- DataLoader(BatchLoader<K, V>) - Constructor for class org.dataloader.DataLoader
-
Deprecated.
- DataLoader(BatchLoader<K, V>, DataLoaderOptions) - Constructor for class org.dataloader.DataLoader
-
Deprecated.use
DataLoaderFactory
instead - DataLoaderAssertionException - Exception Class in org.dataloader.impl
- DataLoaderAssertionException(String) - Constructor for exception class org.dataloader.impl.DataLoaderAssertionException
- DataLoaderFactory - Class in org.dataloader
-
A factory class to create
DataLoader
s - DataLoaderFactory() - Constructor for class org.dataloader.DataLoaderFactory
- DataLoaderHelper<K,
V> - Class in org.dataloader -
This helps break up the large DataLoader class functionality and it contains the logic to dispatch the promises on behalf of its peer dataloader
- DataLoaderHelper(DataLoader<K, V>, Object, DataLoaderOptions, CacheMap<Object, V>, ValueCache<K, V>, StatisticsCollector, Clock) - Constructor for class org.dataloader.DataLoaderHelper
- DataLoaderHelper.LoaderQueueEntry<K,
V> - Class in org.dataloader - DataLoaderOptions - Class in org.dataloader
-
Configuration options for
DataLoader
instances. - DataLoaderOptions() - Constructor for class org.dataloader.DataLoaderOptions
-
Creates a new data loader options with default settings.
- DataLoaderOptions(DataLoaderOptions) - Constructor for class org.dataloader.DataLoaderOptions
-
Clones the provided data loader options.
- DataLoaderRegistry - Class in org.dataloader
-
This allows data loaders to be registered together into a single place so they can be dispatched as one.
- DataLoaderRegistry() - Constructor for class org.dataloader.DataLoaderRegistry
- DataLoaderRegistry(DataLoaderRegistry.Builder) - Constructor for class org.dataloader.DataLoaderRegistry
- DataLoaderRegistry.Builder - Class in org.dataloader
- dataLoaders - Variable in class org.dataloader.DataLoaderRegistry.Builder
- dataLoaders - Variable in class org.dataloader.DataLoaderRegistry
- dataLoaders - Variable in class org.dataloader.registries.ScheduledDataLoaderRegistry.Builder
- DefaultCacheMap<K,
V> - Class in org.dataloader.impl - DefaultCacheMap() - Constructor for class org.dataloader.impl.DefaultCacheMap
-
Default constructor
- defaultValueCache() - Static method in interface org.dataloader.ValueCache
-
Creates a new value cache, using the default no-op implementation.
- delegateCollector - Variable in class org.dataloader.stats.DelegatingStatisticsCollector
- DelegatingStatisticsCollector - Class in org.dataloader.stats
-
This statistics collector keeps dataloader statistics AND also calls the delegate collector at the same time.
- DelegatingStatisticsCollector(StatisticsCollector) - Constructor for class org.dataloader.stats.DelegatingStatisticsCollector
- delete(K) - Method in interface org.dataloader.CacheMap
-
Deletes the entry with the specified key from the cache map, if it exists.
- delete(K) - Method in class org.dataloader.impl.DefaultCacheMap
-
Deletes the entry with the specified key from the cache map, if it exists.
- delete(K) - Method in class org.dataloader.impl.NoOpValueCache
-
Deletes the entry with the specified key from the value cache, if it exists.
- delete(K) - Method in interface org.dataloader.ValueCache
-
Deletes the entry with the specified key from the value cache, if it exists.
- determineFutureCache(DataLoaderOptions) - Method in class org.dataloader.DataLoader
- determineValueCache(DataLoaderOptions) - Method in class org.dataloader.DataLoader
- dispatch() - Method in class org.dataloader.DataLoader
-
Dispatches the queued load requests to the batch execution function and returns a promise of the result.
- dispatch() - Method in class org.dataloader.DataLoaderHelper
- dispatchAll() - Method in class org.dataloader.DataLoaderRegistry
-
This will called
DataLoader.dispatch()
on each of the registeredDataLoader
s - dispatchAll() - Method in class org.dataloader.registries.ScheduledDataLoaderRegistry
- dispatchAllImmediately() - Method in class org.dataloader.registries.ScheduledDataLoaderRegistry
-
This will immediately dispatch the
DataLoader
s in the registry without testing the predicate - dispatchAllWithCount() - Method in class org.dataloader.DataLoaderRegistry
-
Similar to
DataLoaderRegistry.dispatchAll()
, this callsDataLoader.dispatch()
on each of the registeredDataLoader
s, but returns the number of dispatches. - dispatchAllWithCount() - Method in class org.dataloader.registries.ScheduledDataLoaderRegistry
- dispatchAllWithCountImmediately() - Method in class org.dataloader.registries.ScheduledDataLoaderRegistry
-
This will immediately dispatch the
DataLoader
s in the registry without testing the predicate - dispatchAndJoin() - Method in class org.dataloader.DataLoader
-
Normally
DataLoader.dispatch()
is an asynchronous operation but this version will 'join' on the results if dispatch and wait for them to complete. - dispatchDepth() - Method in class org.dataloader.DataLoader
- dispatchDepth() - Method in class org.dataloader.DataLoaderHelper
- dispatchDepth() - Method in class org.dataloader.DataLoaderRegistry
- dispatchIfDepthGreaterThan(int) - Static method in interface org.dataloader.registries.DispatchPredicate
-
This predicate will return true if the
DataLoader.dispatchDepth()
is greater than the specified depth. - dispatchIfLongerThan(Duration) - Static method in interface org.dataloader.registries.DispatchPredicate
-
This predicate will return true if the
DataLoader
has not be dispatched for at least the duration length of time. - dispatchOrReschedule(String, DataLoader<?, ?>) - Method in class org.dataloader.registries.ScheduledDataLoaderRegistry
- dispatchPredicate - Variable in class org.dataloader.registries.ScheduledDataLoaderRegistry.Builder
- dispatchPredicate - Variable in class org.dataloader.registries.ScheduledDataLoaderRegistry
- dispatchPredicate(DispatchPredicate) - Method in class org.dataloader.registries.ScheduledDataLoaderRegistry.Builder
- DispatchPredicate - Interface in org.dataloader.registries
-
A predicate class used by
ScheduledDataLoaderRegistry
to decide whether to dispatch or not - dispatchQueueBatch(List<K>, List<Object>, List<CompletableFuture<V>>) - Method in class org.dataloader.DataLoaderHelper
- DispatchResult<T> - Class in org.dataloader
-
When a DataLoader is dispatched this object holds the promised results and also the count of key asked for via methods like
DataLoader.load(Object)
orDataLoader.loadMany(java.util.List)
- DispatchResult(CompletableFuture<List<T>>, int) - Constructor for class org.dataloader.DispatchResult
- dispatchWithCounts() - Method in class org.dataloader.DataLoader
-
Dispatches the queued load requests to the batch execution function and returns both the promise of the result and the number of entries that were dispatched.
E
- environmentProvider - Variable in class org.dataloader.DataLoaderOptions
- ExperimentalApi - Annotation Type in org.dataloader.annotations
-
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.
F
- failed() - Method in interface org.dataloader.impl.PromisedValues
- failed() - Method in class org.dataloader.impl.PromisedValuesImpl
- failed(Throwable) - Static method in class org.dataloader.Try
-
Creates a Try that has failed with the provided throwable
- failed(CompletableFuture<V>) - Static method in class org.dataloader.impl.CompletableFutureKit
- failedFuture(Exception) - Static method in class org.dataloader.impl.CompletableFutureKit
- fillInStackTrace() - Method in exception class org.dataloader.ValueCache.ValueCachingNotSupported
- flatMap(Function<? super V, Try<U>>) - Method in class org.dataloader.Try
-
Flats maps the Try into another Try type
- forEach(Consumer<? super V>) - Method in class org.dataloader.Try
-
Called the action if the Try has a successful value
- futureCache - Variable in class org.dataloader.DataLoader
- futureCache - Variable in class org.dataloader.DataLoaderHelper
- futureList - Variable in class org.dataloader.DispatchResult
- futures - Variable in class org.dataloader.impl.PromisedValuesImpl
G
- get() - Method in interface org.dataloader.BatchLoaderEnvironmentProvider
- get() - Method in class org.dataloader.Try
- get(int) - Method in interface org.dataloader.impl.PromisedValues
-
The value at index or null if it failed
- get(int) - Method in class org.dataloader.impl.PromisedValuesImpl
- get(K) - Method in interface org.dataloader.CacheMap
-
Gets the specified key from the cache map.
- get(K) - Method in class org.dataloader.impl.DefaultCacheMap
-
Gets the specified key from the cache map.
- get(K) - Method in class org.dataloader.impl.NoOpValueCache
-
Gets the specified key from the value cache.
- get(K) - Method in interface org.dataloader.ValueCache
-
Gets the specified key from the value cache.
- getAll() - Method in interface org.dataloader.CacheMap
-
Gets a collection of CompletableFutures from the cache map.
- getAll() - Method in class org.dataloader.impl.DefaultCacheMap
-
Gets a collection of CompletableFutures from the cache map.
- getBatchInvokeCount() - Method in class org.dataloader.stats.Statistics
- getBatchLoadCount() - Method in class org.dataloader.stats.Statistics
- getBatchLoaderContextProvider() - Method in class org.dataloader.DataLoaderOptions
- getBatchLoadExceptionCount() - Method in class org.dataloader.stats.Statistics
- getBatchLoadExceptionRatio() - Method in class org.dataloader.stats.Statistics
- getBatchLoadRatio() - Method in class org.dataloader.stats.Statistics
- getCacheHitCount() - Method in class org.dataloader.stats.Statistics
- getCacheHitRatio() - Method in class org.dataloader.stats.Statistics
- getCacheKey(K) - Method in class org.dataloader.DataLoader
-
Gets the object that is used in the internal cache map as key, by applying the cache key function to the provided key.
- getCacheKey(K) - Method in class org.dataloader.DataLoaderHelper
- getCacheKeyWithContext(K, Object) - Method in class org.dataloader.DataLoaderHelper
- getCacheMap() - Method in class org.dataloader.DataLoader
-
Gets the cacheMap associated with this data loader passed in via
DataLoaderOptions.cacheMap()
- getCacheMissCount() - Method in class org.dataloader.stats.Statistics
- getCallContext() - Method in class org.dataloader.DataLoaderHelper.LoaderQueueEntry
- getCallContext() - Method in class org.dataloader.stats.context.IncrementCacheHitCountStatisticsContext
- getCallContext() - Method in class org.dataloader.stats.context.IncrementLoadCountStatisticsContext
- getCallContext() - Method in class org.dataloader.stats.context.IncrementLoadErrorCountStatisticsContext
- getCallContexts() - Method in class org.dataloader.stats.context.IncrementBatchLoadCountByStatisticsContext
- getCallContexts() - Method in class org.dataloader.stats.context.IncrementBatchLoadExceptionCountStatisticsContext
- getContext() - Method in interface org.dataloader.BatchLoaderContextProvider
- getContext() - Method in class org.dataloader.BatchLoaderEnvironment
-
Returns the overall context object provided by
BatchLoaderContextProvider
- getDataLoader(String) - Method in class org.dataloader.DataLoaderRegistry
-
Returns the dataloader that was registered under the specified key
- getDataLoaders() - Method in class org.dataloader.DataLoaderRegistry
- getDataLoadersMap() - Method in class org.dataloader.DataLoaderRegistry
- getDelegateStatistics() - Method in class org.dataloader.stats.DelegatingStatisticsCollector
- getFromValueCache(List<K>) - Method in class org.dataloader.DataLoaderHelper
- getIfCompleted(K) - Method in class org.dataloader.DataLoader
-
This will return an optional promise to a value previously loaded via a
DataLoader.load(Object)
call that has in fact been completed or empty if no call has been made for that key or the promise has not completed yet. - getIfCompleted(K) - Method in class org.dataloader.DataLoaderHelper
- getIfPresent(K) - Method in class org.dataloader.DataLoader
-
This will return an optional promise to a value previously loaded via a
DataLoader.load(Object)
call or empty if not call has been made for that key. - getIfPresent(K) - Method in class org.dataloader.DataLoaderHelper
- getKey() - Method in class org.dataloader.DataLoaderHelper.LoaderQueueEntry
- getKey() - Method in class org.dataloader.stats.context.IncrementCacheHitCountStatisticsContext
- getKey() - Method in class org.dataloader.stats.context.IncrementLoadCountStatisticsContext
- getKey() - Method in class org.dataloader.stats.context.IncrementLoadErrorCountStatisticsContext
- getKey(K) - Method in interface org.dataloader.CacheKey
-
Returns the cache key that is created from the provided input key.
- getKeyContexts() - Method in class org.dataloader.BatchLoaderEnvironment
-
Each call to
DataLoader.load(Object, Object)
orDataLoader.loadMany(java.util.List, java.util.List)
can be given a context object when it is invoked. - getKeyContextsList() - Method in class org.dataloader.BatchLoaderEnvironment
-
Each call to
DataLoader.load(Object, Object)
orDataLoader.loadMany(java.util.List, java.util.List)
can be given a context object when it is invoked. - getKeys() - Method in class org.dataloader.DataLoaderRegistry
- getKeys() - Method in class org.dataloader.stats.context.IncrementBatchLoadCountByStatisticsContext
- getKeys() - Method in class org.dataloader.stats.context.IncrementBatchLoadExceptionCountStatisticsContext
- getKeysCount() - Method in class org.dataloader.DispatchResult
- getKeyWithContext(K, Object) - Method in interface org.dataloader.CacheKey
-
Returns the cache key that is created from the provided input key and context.
- getLastDispatchTime() - Method in class org.dataloader.DataLoader
-
This returns the last instant the data loader was dispatched.
- getLastDispatchTime() - Method in class org.dataloader.DataLoaderHelper
- getLoadCount() - Method in class org.dataloader.stats.Statistics
- getLoadErrorCount() - Method in class org.dataloader.stats.Statistics
- getLoadErrorRatio() - Method in class org.dataloader.stats.Statistics
- getOverallStatistics() - Method in class org.dataloader.stats.ThreadLocalStatisticsCollector
-
This returns the overall statistics, that is not per thread but for the life of this object
- getPromisedResults() - Method in class org.dataloader.DispatchResult
- getScheduleDuration() - Method in class org.dataloader.registries.ScheduledDataLoaderRegistry
- getStatistics() - Method in class org.dataloader.DataLoader
-
Gets the statistics associated with this data loader.
- getStatistics() - Method in class org.dataloader.DataLoaderRegistry
- getStatistics() - Method in class org.dataloader.stats.DelegatingStatisticsCollector
- getStatistics() - Method in class org.dataloader.stats.NoOpStatisticsCollector
- getStatistics() - Method in class org.dataloader.stats.SimpleStatisticsCollector
- getStatistics() - Method in interface org.dataloader.stats.StatisticsCollector
- getStatistics() - Method in class org.dataloader.stats.ThreadLocalStatisticsCollector
-
This returns the statistics for this thread.
- getStatisticsCollector() - Method in class org.dataloader.DataLoaderOptions
- getThrowable() - Method in class org.dataloader.Try
- getTimeSinceDispatch() - Method in class org.dataloader.DataLoader
-
This returns the
Duration
since the data loader was dispatched. - getValue() - Method in class org.dataloader.DataLoaderHelper.LoaderQueueEntry
- getValueCache() - Method in class org.dataloader.DataLoader
-
Gets the valueCache associated with this data loader passed in via
DataLoaderOptions.valueCache()
- getValueCacheOptions() - Method in class org.dataloader.DataLoaderOptions
- getValues(List<K>) - Method in class org.dataloader.impl.NoOpValueCache
- getValues(List<K>) - Method in interface org.dataloader.ValueCache
-
Gets the specified keys from the value cache, in a batch call.
- GuardedBy - Annotation Type in org.dataloader.annotations
-
Indicates that the annotated element should be used only while holding the specified lock.
H
- helper - Variable in class org.dataloader.DataLoader
I
- incrementBatchLoadCountBy(long) - Method in class org.dataloader.stats.DelegatingStatisticsCollector
-
Deprecated.
- incrementBatchLoadCountBy(long) - Method in class org.dataloader.stats.NoOpStatisticsCollector
-
Deprecated.
- incrementBatchLoadCountBy(long) - Method in class org.dataloader.stats.SimpleStatisticsCollector
-
Deprecated.
- incrementBatchLoadCountBy(long) - Method in interface org.dataloader.stats.StatisticsCollector
- incrementBatchLoadCountBy(long) - Method in class org.dataloader.stats.ThreadLocalStatisticsCollector
-
Deprecated.
- incrementBatchLoadCountBy(long, IncrementBatchLoadCountByStatisticsContext<K>) - Method in class org.dataloader.stats.DelegatingStatisticsCollector
- incrementBatchLoadCountBy(long, IncrementBatchLoadCountByStatisticsContext<K>) - Method in class org.dataloader.stats.NoOpStatisticsCollector
- incrementBatchLoadCountBy(long, IncrementBatchLoadCountByStatisticsContext<K>) - Method in class org.dataloader.stats.SimpleStatisticsCollector
- incrementBatchLoadCountBy(long, IncrementBatchLoadCountByStatisticsContext<K>) - Method in interface org.dataloader.stats.StatisticsCollector
-
Called to increment the number of batch loads
- incrementBatchLoadCountBy(long, IncrementBatchLoadCountByStatisticsContext<K>) - Method in class org.dataloader.stats.ThreadLocalStatisticsCollector
- IncrementBatchLoadCountByStatisticsContext<K> - Class in org.dataloader.stats.context
- IncrementBatchLoadCountByStatisticsContext(List<K>, List<Object>) - Constructor for class org.dataloader.stats.context.IncrementBatchLoadCountByStatisticsContext
- IncrementBatchLoadCountByStatisticsContext(K, Object) - Constructor for class org.dataloader.stats.context.IncrementBatchLoadCountByStatisticsContext
- incrementBatchLoadExceptionCount() - Method in class org.dataloader.stats.DelegatingStatisticsCollector
-
Deprecated.
- incrementBatchLoadExceptionCount() - Method in class org.dataloader.stats.NoOpStatisticsCollector
-
Deprecated.
- incrementBatchLoadExceptionCount() - Method in class org.dataloader.stats.SimpleStatisticsCollector
-
Deprecated.
- incrementBatchLoadExceptionCount() - Method in interface org.dataloader.stats.StatisticsCollector
- incrementBatchLoadExceptionCount() - Method in class org.dataloader.stats.ThreadLocalStatisticsCollector
-
Deprecated.
- incrementBatchLoadExceptionCount(IncrementBatchLoadExceptionCountStatisticsContext<K>) - Method in class org.dataloader.stats.DelegatingStatisticsCollector
- incrementBatchLoadExceptionCount(IncrementBatchLoadExceptionCountStatisticsContext<K>) - Method in class org.dataloader.stats.NoOpStatisticsCollector
- incrementBatchLoadExceptionCount(IncrementBatchLoadExceptionCountStatisticsContext<K>) - Method in class org.dataloader.stats.SimpleStatisticsCollector
- incrementBatchLoadExceptionCount(IncrementBatchLoadExceptionCountStatisticsContext<K>) - Method in interface org.dataloader.stats.StatisticsCollector
-
Called to increment the number of batch loads exceptions
- incrementBatchLoadExceptionCount(IncrementBatchLoadExceptionCountStatisticsContext<K>) - Method in class org.dataloader.stats.ThreadLocalStatisticsCollector
- IncrementBatchLoadExceptionCountStatisticsContext<K> - Class in org.dataloader.stats.context
- IncrementBatchLoadExceptionCountStatisticsContext(List<K>, List<Object>) - Constructor for class org.dataloader.stats.context.IncrementBatchLoadExceptionCountStatisticsContext
- incrementCacheHitCount() - Method in class org.dataloader.stats.DelegatingStatisticsCollector
-
Deprecated.
- incrementCacheHitCount() - Method in class org.dataloader.stats.NoOpStatisticsCollector
-
Deprecated.
- incrementCacheHitCount() - Method in class org.dataloader.stats.SimpleStatisticsCollector
-
Deprecated.
- incrementCacheHitCount() - Method in interface org.dataloader.stats.StatisticsCollector
- incrementCacheHitCount() - Method in class org.dataloader.stats.ThreadLocalStatisticsCollector
-
Deprecated.
- incrementCacheHitCount(IncrementCacheHitCountStatisticsContext<K>) - Method in class org.dataloader.stats.DelegatingStatisticsCollector
- incrementCacheHitCount(IncrementCacheHitCountStatisticsContext<K>) - Method in class org.dataloader.stats.NoOpStatisticsCollector
- incrementCacheHitCount(IncrementCacheHitCountStatisticsContext<K>) - Method in class org.dataloader.stats.SimpleStatisticsCollector
- incrementCacheHitCount(IncrementCacheHitCountStatisticsContext<K>) - Method in interface org.dataloader.stats.StatisticsCollector
-
Called to increment the number of cache hits
- incrementCacheHitCount(IncrementCacheHitCountStatisticsContext<K>) - Method in class org.dataloader.stats.ThreadLocalStatisticsCollector
- IncrementCacheHitCountStatisticsContext<K> - Class in org.dataloader.stats.context
- IncrementCacheHitCountStatisticsContext(K) - Constructor for class org.dataloader.stats.context.IncrementCacheHitCountStatisticsContext
- IncrementCacheHitCountStatisticsContext(K, Object) - Constructor for class org.dataloader.stats.context.IncrementCacheHitCountStatisticsContext
- incrementLoadCount() - Method in class org.dataloader.stats.DelegatingStatisticsCollector
-
Deprecated.
- incrementLoadCount() - Method in class org.dataloader.stats.NoOpStatisticsCollector
-
Deprecated.
- incrementLoadCount() - Method in class org.dataloader.stats.SimpleStatisticsCollector
-
Deprecated.
- incrementLoadCount() - Method in interface org.dataloader.stats.StatisticsCollector
- incrementLoadCount() - Method in class org.dataloader.stats.ThreadLocalStatisticsCollector
-
Deprecated.
- incrementLoadCount(IncrementLoadCountStatisticsContext<K>) - Method in class org.dataloader.stats.DelegatingStatisticsCollector
- incrementLoadCount(IncrementLoadCountStatisticsContext<K>) - Method in class org.dataloader.stats.NoOpStatisticsCollector
- incrementLoadCount(IncrementLoadCountStatisticsContext<K>) - Method in class org.dataloader.stats.SimpleStatisticsCollector
- incrementLoadCount(IncrementLoadCountStatisticsContext<K>) - Method in interface org.dataloader.stats.StatisticsCollector
-
Called to increment the number of loads
- incrementLoadCount(IncrementLoadCountStatisticsContext<K>) - Method in class org.dataloader.stats.ThreadLocalStatisticsCollector
- IncrementLoadCountStatisticsContext<K> - Class in org.dataloader.stats.context
- IncrementLoadCountStatisticsContext(K, Object) - Constructor for class org.dataloader.stats.context.IncrementLoadCountStatisticsContext
- incrementLoadErrorCount() - Method in class org.dataloader.stats.DelegatingStatisticsCollector
-
Deprecated.
- incrementLoadErrorCount() - Method in class org.dataloader.stats.NoOpStatisticsCollector
-
Deprecated.
- incrementLoadErrorCount() - Method in class org.dataloader.stats.SimpleStatisticsCollector
-
Deprecated.
- incrementLoadErrorCount() - Method in interface org.dataloader.stats.StatisticsCollector
- incrementLoadErrorCount() - Method in class org.dataloader.stats.ThreadLocalStatisticsCollector
-
Deprecated.
- incrementLoadErrorCount(IncrementLoadErrorCountStatisticsContext<K>) - Method in class org.dataloader.stats.DelegatingStatisticsCollector
- incrementLoadErrorCount(IncrementLoadErrorCountStatisticsContext<K>) - Method in class org.dataloader.stats.NoOpStatisticsCollector
- incrementLoadErrorCount(IncrementLoadErrorCountStatisticsContext<K>) - Method in class org.dataloader.stats.SimpleStatisticsCollector
- incrementLoadErrorCount(IncrementLoadErrorCountStatisticsContext<K>) - Method in interface org.dataloader.stats.StatisticsCollector
-
Called to increment the number of loads that resulted in an object deemed in error
- incrementLoadErrorCount(IncrementLoadErrorCountStatisticsContext<K>) - Method in class org.dataloader.stats.ThreadLocalStatisticsCollector
- IncrementLoadErrorCountStatisticsContext<K> - Class in org.dataloader.stats.context
- IncrementLoadErrorCountStatisticsContext(K, Object) - Constructor for class org.dataloader.stats.context.IncrementLoadErrorCountStatisticsContext
- Internal - Annotation Type in org.dataloader.annotations
-
This represents code that the java-dataloader project considers internal code that MAY not be stable within major releases.
- invokeListBatchLoader(List<K>, BatchLoaderEnvironment) - Method in class org.dataloader.DataLoaderHelper
- invokeLoader(List<K>, List<Object>) - Method in class org.dataloader.DataLoaderHelper
- invokeLoader(List<K>, List<Object>, boolean) - Method in class org.dataloader.DataLoaderHelper
- invokeLoaderImmediately(K, Object, boolean) - Method in class org.dataloader.DataLoaderHelper
- invokeMapBatchLoader(List<K>, BatchLoaderEnvironment) - Method in class org.dataloader.DataLoaderHelper
- isCompleteValueAfterCacheSet() - Method in class org.dataloader.ValueCacheOptions
-
This controls whether the
DataLoader
will wait for theValueCache.set(Object, Object)
call to complete before it completes the returned value. - isDone() - Method in interface org.dataloader.impl.PromisedValues
-
The true if the all the futures have completed (and hence this
PromisedValues
has completed) - isDone() - Method in class org.dataloader.impl.PromisedValuesImpl
- isFailure() - Method in class org.dataloader.Try
- isMapLoader() - Method in class org.dataloader.DataLoaderHelper
- isSuccess() - Method in class org.dataloader.Try
J
- join() - Method in interface org.dataloader.impl.PromisedValues
-
Waits for the underlying futures to complete.
- join() - Method in class org.dataloader.impl.PromisedValuesImpl
K
- key - Variable in class org.dataloader.DataLoaderHelper.LoaderQueueEntry
- key - Variable in class org.dataloader.stats.context.IncrementCacheHitCountStatisticsContext
- key - Variable in class org.dataloader.stats.context.IncrementLoadCountStatisticsContext
- key - Variable in class org.dataloader.stats.context.IncrementLoadErrorCountStatisticsContext
- keyContexts - Variable in class org.dataloader.BatchLoaderEnvironment.Builder
- keyContexts - Variable in class org.dataloader.BatchLoaderEnvironment
- keyContexts(List<K>, List<Object>) - Method in class org.dataloader.BatchLoaderEnvironment.Builder
- keyContextsList - Variable in class org.dataloader.BatchLoaderEnvironment.Builder
- keyContextsList - Variable in class org.dataloader.BatchLoaderEnvironment
- keys - Variable in class org.dataloader.stats.context.IncrementBatchLoadCountByStatisticsContext
- keys - Variable in class org.dataloader.stats.context.IncrementBatchLoadExceptionCountStatisticsContext
- keysCount - Variable in class org.dataloader.DispatchResult
L
- lastDispatchTime - Variable in class org.dataloader.DataLoaderHelper
- load(List<K>) - Method in interface org.dataloader.BatchLoader
-
Called to batch load the provided keys and return a promise to a list of values.
- load(List<K>, BatchLoaderEnvironment) - Method in interface org.dataloader.BatchLoaderWithContext
-
Called to batch load the provided keys and return a promise to a list of values.
- load(Set<K>) - Method in interface org.dataloader.MappedBatchLoader
-
Called to batch load the provided keys and return a promise to a map of values.
- load(Set<K>, BatchLoaderEnvironment) - Method in interface org.dataloader.MappedBatchLoaderWithContext
-
Called to batch load the provided keys and return a promise to a map of values.
- load(K) - Method in class org.dataloader.DataLoader
-
Requests to load the data with the specified key asynchronously, and returns a future of the resulting value.
- load(K, Object) - Method in class org.dataloader.DataLoader
-
Requests to load the data with the specified key asynchronously, and returns a future of the resulting value.
- load(K, Object) - Method in class org.dataloader.DataLoaderHelper
- loadCount - Variable in class org.dataloader.stats.SimpleStatisticsCollector
- loadCount - Variable in class org.dataloader.stats.Statistics
- loaderOptions - Variable in class org.dataloader.DataLoaderHelper
- loaderQueue - Variable in class org.dataloader.DataLoaderHelper
- LoaderQueueEntry(K, V, Object) - Constructor for class org.dataloader.DataLoaderHelper.LoaderQueueEntry
- loadErrorCount - Variable in class org.dataloader.stats.SimpleStatisticsCollector
- loadErrorCount - Variable in class org.dataloader.stats.Statistics
- loadFromCache(K, Object, boolean) - Method in class org.dataloader.DataLoaderHelper
- loadMany(List<K>) - Method in class org.dataloader.DataLoader
-
Requests to load the list of data provided by the specified keys asynchronously, and returns a composite future of the resulting values.
- loadMany(List<K>, List<Object>) - Method in class org.dataloader.DataLoader
-
Requests to load the list of data provided by the specified keys asynchronously, and returns a composite future of the resulting values.
M
- map(Function<? super V, U>) - Method in class org.dataloader.Try
-
Maps the Try into another Try with a different type
- MappedBatchLoader<K,
V> - Interface in org.dataloader -
A function that is invoked for batch loading a map of of data values indicated by the provided set of keys.
- MappedBatchLoaderWithContext<K,
V> - Interface in org.dataloader -
This form of
MappedBatchLoader
is given aBatchLoaderEnvironment
object that encapsulates the calling context. - maxBatchSize - Variable in class org.dataloader.DataLoaderOptions
- maxBatchSize() - Method in class org.dataloader.DataLoaderOptions
-
Gets the maximum number of keys that will be presented to the
BatchLoader
function before they are split into multiple class - mkDataLoader(Object, DataLoaderOptions) - Static method in class org.dataloader.DataLoaderFactory
N
- negate() - Method in interface org.dataloader.registries.DispatchPredicate
-
Returns a predicate that represents the logical negation of this predicate.
- newBatchLoaderEnvironment() - Static method in class org.dataloader.BatchLoaderEnvironment
- newDataLoader(BatchLoader<K, V>) - Static method in class org.dataloader.DataLoader
-
Deprecated.use
DataLoaderFactory
instead - newDataLoader(BatchLoader<K, V>) - Static method in class org.dataloader.DataLoaderFactory
-
Creates new DataLoader with the specified batch loader function and default options (batching, caching and unlimited batch size).
- newDataLoader(BatchLoader<K, V>, DataLoaderOptions) - Static method in class org.dataloader.DataLoader
-
Deprecated.use
DataLoaderFactory
instead - newDataLoader(BatchLoader<K, V>, DataLoaderOptions) - Static method in class org.dataloader.DataLoaderFactory
-
Creates new DataLoader with the specified batch loader function with the provided options
- newDataLoader(BatchLoaderWithContext<K, V>) - Static method in class org.dataloader.DataLoader
-
Deprecated.use
DataLoaderFactory
instead - newDataLoader(BatchLoaderWithContext<K, V>) - Static method in class org.dataloader.DataLoaderFactory
-
Creates new DataLoader with the specified batch loader function and default options (batching, caching and unlimited batch size).
- newDataLoader(BatchLoaderWithContext<K, V>, DataLoaderOptions) - Static method in class org.dataloader.DataLoader
-
Deprecated.use
DataLoaderFactory
instead - newDataLoader(BatchLoaderWithContext<K, V>, DataLoaderOptions) - Static method in class org.dataloader.DataLoaderFactory
-
Creates new DataLoader with the specified batch loader function with the provided options
- newDataLoaderWithTry(BatchLoader<K, Try<V>>) - Static method in class org.dataloader.DataLoader
-
Deprecated.use
DataLoaderFactory
instead - newDataLoaderWithTry(BatchLoader<K, Try<V>>) - Static method in class org.dataloader.DataLoaderFactory
-
Creates new DataLoader with the specified batch loader function and default options (batching, caching and unlimited batch size) where the batch loader function returns a list of
Try
objects. - newDataLoaderWithTry(BatchLoader<K, Try<V>>, DataLoaderOptions) - Static method in class org.dataloader.DataLoader
-
Deprecated.use
DataLoaderFactory
instead - newDataLoaderWithTry(BatchLoader<K, Try<V>>, DataLoaderOptions) - Static method in class org.dataloader.DataLoaderFactory
-
Creates new DataLoader with the specified batch loader function and with the provided options where the batch loader function returns a list of
Try
objects. - newDataLoaderWithTry(BatchLoaderWithContext<K, Try<V>>) - Static method in class org.dataloader.DataLoader
-
Deprecated.use
DataLoaderFactory
instead - newDataLoaderWithTry(BatchLoaderWithContext<K, Try<V>>) - Static method in class org.dataloader.DataLoaderFactory
-
Creates new DataLoader with the specified batch loader function and default options (batching, caching and unlimited batch size) where the batch loader function returns a list of
Try
objects. - newDataLoaderWithTry(BatchLoaderWithContext<K, Try<V>>, DataLoaderOptions) - Static method in class org.dataloader.DataLoader
-
Deprecated.use
DataLoaderFactory
instead - newDataLoaderWithTry(BatchLoaderWithContext<K, Try<V>>, DataLoaderOptions) - Static method in class org.dataloader.DataLoaderFactory
-
Creates new DataLoader with the specified batch loader function and with the provided options where the batch loader function returns a list of
Try
objects. - newMappedDataLoader(MappedBatchLoader<K, V>) - Static method in class org.dataloader.DataLoader
-
Deprecated.use
DataLoaderFactory
instead - newMappedDataLoader(MappedBatchLoader<K, V>) - Static method in class org.dataloader.DataLoaderFactory
-
Creates new DataLoader with the specified batch loader function and default options (batching, caching and unlimited batch size).
- newMappedDataLoader(MappedBatchLoader<K, V>, DataLoaderOptions) - Static method in class org.dataloader.DataLoader
-
Deprecated.use
DataLoaderFactory
instead - newMappedDataLoader(MappedBatchLoader<K, V>, DataLoaderOptions) - Static method in class org.dataloader.DataLoaderFactory
-
Creates new DataLoader with the specified batch loader function with the provided options
- newMappedDataLoader(MappedBatchLoaderWithContext<K, V>) - Static method in class org.dataloader.DataLoader
-
Deprecated.use
DataLoaderFactory
instead - newMappedDataLoader(MappedBatchLoaderWithContext<K, V>) - Static method in class org.dataloader.DataLoaderFactory
-
Creates new DataLoader with the specified mapped batch loader function and default options (batching, caching and unlimited batch size).
- newMappedDataLoader(MappedBatchLoaderWithContext<K, V>, DataLoaderOptions) - Static method in class org.dataloader.DataLoader
-
Deprecated.use
DataLoaderFactory
instead - newMappedDataLoader(MappedBatchLoaderWithContext<K, V>, DataLoaderOptions) - Static method in class org.dataloader.DataLoaderFactory
-
Creates new DataLoader with the specified batch loader function with the provided options
- newMappedDataLoaderWithTry(MappedBatchLoader<K, Try<V>>) - Static method in class org.dataloader.DataLoader
-
Deprecated.use
DataLoaderFactory
instead - newMappedDataLoaderWithTry(MappedBatchLoader<K, Try<V>>) - Static method in class org.dataloader.DataLoaderFactory
-
Creates new DataLoader with the specified batch loader function and default options (batching, caching and unlimited batch size) where the batch loader function returns a list of
Try
objects. - newMappedDataLoaderWithTry(MappedBatchLoader<K, Try<V>>, DataLoaderOptions) - Static method in class org.dataloader.DataLoader
-
Deprecated.use
DataLoaderFactory
instead - newMappedDataLoaderWithTry(MappedBatchLoader<K, Try<V>>, DataLoaderOptions) - Static method in class org.dataloader.DataLoaderFactory
-
Creates new DataLoader with the specified batch loader function and with the provided options where the batch loader function returns a list of
Try
objects. - newMappedDataLoaderWithTry(MappedBatchLoaderWithContext<K, Try<V>>) - Static method in class org.dataloader.DataLoader
-
Deprecated.use
DataLoaderFactory
instead - newMappedDataLoaderWithTry(MappedBatchLoaderWithContext<K, Try<V>>) - Static method in class org.dataloader.DataLoaderFactory
-
Creates new DataLoader with the specified batch loader function and default options (batching, caching and unlimited batch size) where the batch loader function returns a list of
Try
objects. - newMappedDataLoaderWithTry(MappedBatchLoaderWithContext<K, Try<V>>, DataLoaderOptions) - Static method in class org.dataloader.DataLoader
-
Deprecated.use
DataLoaderFactory
instead - newMappedDataLoaderWithTry(MappedBatchLoaderWithContext<K, Try<V>>, DataLoaderOptions) - Static method in class org.dataloader.DataLoaderFactory
-
Creates new DataLoader with the specified batch loader function and with the provided options where the batch loader function returns a list of
Try
objects. - newOptions() - Static method in class org.dataloader.DataLoaderOptions
- newOptions() - Static method in class org.dataloader.ValueCacheOptions
- newRegistry() - Static method in class org.dataloader.DataLoaderRegistry
- newScheduledRegistry() - Static method in class org.dataloader.registries.ScheduledDataLoaderRegistry
-
By default this will create use a
Executors.newSingleThreadScheduledExecutor()
and a schedule duration of 10 milli seconds. - NIL - Static variable in class org.dataloader.Try
- NIL_THROWABLE - Static variable in class org.dataloader.Try
- nonNull(T) - Static method in class org.dataloader.impl.Assertions
- nonNull(T, Supplier<String>) - Static method in class org.dataloader.impl.Assertions
- NOOP - Static variable in class org.dataloader.impl.NoOpValueCache
-
a no op value cache instance
- NoOpStatisticsCollector - Class in org.dataloader.stats
-
A statistics collector that does nothing
- NoOpStatisticsCollector() - Constructor for class org.dataloader.stats.NoOpStatisticsCollector
- NoOpValueCache<K,
V> - Class in org.dataloader.impl -
Implementation of
ValueCache
that does nothing. - NoOpValueCache() - Constructor for class org.dataloader.impl.NoOpValueCache
- NOT_SUPPORTED - Variable in class org.dataloader.DataLoaderHelper
- NOT_SUPPORTED - Variable in class org.dataloader.impl.NoOpValueCache
- NOT_SUPPORTED_CF - Variable in class org.dataloader.impl.NoOpValueCache
- NOT_SUPPORTED_LIST - Variable in class org.dataloader.DataLoaderHelper
- NOT_SUPPORTED_VOID_CF - Variable in class org.dataloader.impl.NoOpValueCache
- now() - Method in class org.dataloader.DataLoaderHelper
- NULL_PROVIDER - Static variable in class org.dataloader.DataLoaderOptions
O
- or(DispatchPredicate) - Method in interface org.dataloader.registries.DispatchPredicate
-
Returns a composed predicate that represents a short-circuiting logical OR of this predicate and another.
- orElse(V) - Method in class org.dataloader.Try
-
Returns the successful value of the Try or other if it failed
- orElseGet(Supplier<V>) - Method in class org.dataloader.Try
-
Returns the successful value of the Try or the supplied other if it failed
- org.dataloader - package org.dataloader
- org.dataloader.annotations - package org.dataloader.annotations
- org.dataloader.impl - package org.dataloader.impl
- org.dataloader.registries - package org.dataloader.registries
- org.dataloader.stats - package org.dataloader.stats
- org.dataloader.stats.context - package org.dataloader.stats.context
- overallCollector - Variable in class org.dataloader.stats.ThreadLocalStatisticsCollector
P
- possiblyClearCacheEntriesOnExceptions(List<K>) - Method in class org.dataloader.DataLoaderHelper
- prime(K, Exception) - Method in class org.dataloader.DataLoader
-
Primes the cache with the given key and error.
- prime(K, CompletableFuture<V>) - Method in class org.dataloader.DataLoader
-
Primes the cache with the given key and value.
- prime(K, V) - Method in class org.dataloader.DataLoader
-
Primes the cache with the given key and value.
- PromisedValues<T> - Interface in org.dataloader.impl
-
This allows multiple
CompletionStage
s to be combined together and completed as one and should something go wrong, instead of throwingCompletionException
s it captures the cause and returns null for that data value, other wise it allows you to access them as a list of values. - PromisedValuesImpl<T> - Class in org.dataloader.impl
- PromisedValuesImpl(List<? extends CompletionStage<T>>) - Constructor for class org.dataloader.impl.PromisedValuesImpl
- PromisedValuesImpl(PromisedValuesImpl<T>, CompletionStage<Void>) - Constructor for class org.dataloader.impl.PromisedValuesImpl
- PublicApi - Annotation Type in org.dataloader.annotations
-
This represents code that the java-dataloader project considers public API and has an imperative to be stable within major releases.
- PublicSpi - Annotation Type in org.dataloader.annotations
-
This represents code that the java-dataloader project considers public SPI and has an imperative to be stable within major releases.
Q
- queueOrInvokeLoader(K, Object, boolean, boolean) - Method in class org.dataloader.DataLoaderHelper
R
- ratio(long, long) - Method in class org.dataloader.stats.Statistics
-
A helper to divide two numbers and handle zero
- recover(Function<Throwable, V>) - Method in class org.dataloader.Try
-
Called the recover function of the Try failed otherwise returns this if it was successful.
- register(String, DataLoader<?, ?>) - Method in class org.dataloader.DataLoaderRegistry.Builder
-
This will register a new dataloader
- register(String, DataLoader<?, ?>) - Method in class org.dataloader.DataLoaderRegistry
-
This will register a new dataloader
- register(String, DataLoader<?, ?>) - Method in class org.dataloader.registries.ScheduledDataLoaderRegistry.Builder
-
This will register a new dataloader
- registerAll(DataLoaderRegistry) - Method in class org.dataloader.DataLoaderRegistry.Builder
-
This will combine together the data loaders in this builder with the ones from a previous
DataLoaderRegistry
- registerAll(DataLoaderRegistry) - Method in class org.dataloader.registries.ScheduledDataLoaderRegistry.Builder
-
This will combine together the data loaders in this builder with the ones from a previous
DataLoaderRegistry
- reschedule(String, DataLoader<?, ?>) - Method in class org.dataloader.registries.ScheduledDataLoaderRegistry
- rescheduleNow() - Method in class org.dataloader.registries.ScheduledDataLoaderRegistry
-
This will schedule a task to check the predicate and dispatch if true right now.
- resetThread() - Method in class org.dataloader.stats.ThreadLocalStatisticsCollector
-
Removes the underlying thread local value for this current thread.
- reThrow() - Method in class org.dataloader.Try
-
Rethrows the underlying throwable inside the unsuccessful Try
S
- schedule - Variable in class org.dataloader.registries.ScheduledDataLoaderRegistry.Builder
- schedule - Variable in class org.dataloader.registries.ScheduledDataLoaderRegistry
- schedule(Duration) - Method in class org.dataloader.registries.ScheduledDataLoaderRegistry.Builder
- ScheduledDataLoaderRegistry - Class in org.dataloader.registries
-
This
DataLoaderRegistry
will use aDispatchPredicate
whenScheduledDataLoaderRegistry.dispatchAll()
is called to test (for eachDataLoader
in the registry) if a dispatch should proceed. - ScheduledDataLoaderRegistry(ScheduledDataLoaderRegistry.Builder) - Constructor for class org.dataloader.registries.ScheduledDataLoaderRegistry
- ScheduledDataLoaderRegistry.Builder - Class in org.dataloader.registries
- scheduledExecutorService - Variable in class org.dataloader.registries.ScheduledDataLoaderRegistry.Builder
- scheduledExecutorService - Variable in class org.dataloader.registries.ScheduledDataLoaderRegistry
- scheduledExecutorService(ScheduledExecutorService) - Method in class org.dataloader.registries.ScheduledDataLoaderRegistry.Builder
- set(K, CompletableFuture<V>) - Method in interface org.dataloader.CacheMap
-
Creates a new cache map entry with the specified key and value, or updates the value if the key already exists.
- set(K, CompletableFuture<V>) - Method in class org.dataloader.impl.DefaultCacheMap
-
Creates a new cache map entry with the specified key and value, or updates the value if the key already exists.
- set(K, V) - Method in class org.dataloader.impl.NoOpValueCache
-
Stores the value with the specified key, or updates it if the key already exists.
- set(K, V) - Method in interface org.dataloader.ValueCache
-
Stores the value with the specified key, or updates it if the key already exists.
- setBatchingEnabled(boolean) - Method in class org.dataloader.DataLoaderOptions
-
Sets the option that determines whether batch loading is enabled.
- setBatchLoaderContextProvider(BatchLoaderContextProvider) - Method in class org.dataloader.DataLoaderOptions
-
Sets the batch loader environment provider that will be used to give context to batch load functions
- setCacheKeyFunction(CacheKey<?>) - Method in class org.dataloader.DataLoaderOptions
-
Sets the function to use for creating the cache key, if caching is enabled.
- setCacheMap(CacheMap<?, ?>) - Method in class org.dataloader.DataLoaderOptions
-
Sets the cache map implementation to use for caching, if caching is enabled.
- setCachingEnabled(boolean) - Method in class org.dataloader.DataLoaderOptions
-
Sets the option that determines whether caching is enabled.
- setCachingExceptionsEnabled(boolean) - Method in class org.dataloader.DataLoaderOptions
-
Sets the option that determines whether exceptional values are cachedis enabled.
- setCause(Throwable) - Method in class org.dataloader.impl.PromisedValuesImpl
- setCompleteValueAfterCacheSet(boolean) - Method in class org.dataloader.ValueCacheOptions
- setMaxBatchSize(int) - Method in class org.dataloader.DataLoaderOptions
-
Sets the maximum number of keys that will be presented to the
BatchLoader
function before they are split into multiple class - setStatisticsCollector(Supplier<StatisticsCollector>) - Method in class org.dataloader.DataLoaderOptions
-
Sets the statistics collector supplier that will be used with these data loader options.
- setToValueCache(List<V>, List<K>, List<V>) - Method in class org.dataloader.DataLoaderHelper
- setValueCache(ValueCache<?, ?>) - Method in class org.dataloader.DataLoaderOptions
-
Sets the value cache implementation to use for caching values, if caching is enabled.
- setValueCacheOptions(ValueCacheOptions) - Method in class org.dataloader.DataLoaderOptions
-
Sets the
ValueCacheOptions
that control how theValueCache
will be used - setValues(List<K>, List<V>) - Method in class org.dataloader.impl.NoOpValueCache
- setValues(List<K>, List<V>) - Method in interface org.dataloader.ValueCache
-
Stores the value with the specified keys, or updates it if the keys if they already exist.
- simpleMap() - Static method in interface org.dataloader.CacheMap
-
Creates a new cache map, using the default implementation that is based on a
LinkedHashMap
. - SimpleStatisticsCollector - Class in org.dataloader.stats
-
This simple collector uses
AtomicLong
s to collect statistics - SimpleStatisticsCollector() - Constructor for class org.dataloader.stats.SimpleStatisticsCollector
- size() - Method in interface org.dataloader.impl.PromisedValues
- size() - Method in class org.dataloader.impl.PromisedValuesImpl
- sliceIntoBatchesOfBatches(List<K>, List<CompletableFuture<V>>, List<Object>, int) - Method in class org.dataloader.DataLoaderHelper
- Statistics - Class in org.dataloader.stats
-
This holds statistics on how a
DataLoader
has performed - Statistics() - Constructor for class org.dataloader.stats.Statistics
-
Zero statistics
- Statistics(long, long, long, long, long, long) - Constructor for class org.dataloader.stats.Statistics
- statisticsCollector - Variable in class org.dataloader.DataLoaderOptions
- StatisticsCollector - Interface in org.dataloader.stats
-
This allows statistics to be collected for
DataLoader
operations - stats - Variable in class org.dataloader.DataLoader
- stats - Variable in class org.dataloader.DataLoaderHelper
- succeeded() - Method in interface org.dataloader.impl.PromisedValues
- succeeded() - Method in class org.dataloader.impl.PromisedValuesImpl
- succeeded(int) - Method in interface org.dataloader.impl.PromisedValues
-
The true if the
CompletionStage
at the specified index succeeded - succeeded(int) - Method in class org.dataloader.impl.PromisedValuesImpl
- succeeded(CompletableFuture<V>) - Static method in class org.dataloader.impl.CompletableFutureKit
- succeeded(V) - Static method in class org.dataloader.Try
-
Creates a Try that has succeeded with the provided value
T
- test(String, DataLoader<?, ?>) - Method in interface org.dataloader.registries.DispatchPredicate
-
This predicate tests whether the data loader should be dispatched or not.
- thenAccept(Consumer<PromisedValues<T>>) - Method in interface org.dataloader.impl.PromisedValues
-
When the all the futures complete, this call back will be invoked with this
PromisedValues
as a parameter - thenAccept(Consumer<PromisedValues<T>>) - Method in class org.dataloader.impl.PromisedValuesImpl
- ThreadLocalStatisticsCollector - Class in org.dataloader.stats
-
This can collect statistics per thread as well as in an overall sense.
- ThreadLocalStatisticsCollector() - Constructor for class org.dataloader.stats.ThreadLocalStatisticsCollector
- throwable - Variable in class org.dataloader.Try
- toCompletableFuture() - Method in interface org.dataloader.impl.PromisedValues
- toCompletableFuture() - Method in class org.dataloader.impl.PromisedValuesImpl
- toList() - Method in interface org.dataloader.impl.PromisedValues
-
Returns the underlying values as a list
- toList() - Method in class org.dataloader.impl.PromisedValuesImpl
- toMap() - Method in class org.dataloader.stats.Statistics
- toOptional() - Method in class org.dataloader.Try
-
Converts the Try into an Optional where unsuccessful tries are empty
- toString() - Method in class org.dataloader.stats.SimpleStatisticsCollector
- toString() - Method in class org.dataloader.stats.Statistics
- toString() - Method in class org.dataloader.stats.ThreadLocalStatisticsCollector
- toString() - Method in class org.dataloader.Try
- Try<V> - Class in org.dataloader
-
Try is class that allows you to hold the result of computation or the throwable it produced.
- Try(Throwable) - Constructor for class org.dataloader.Try
- Try(V) - Constructor for class org.dataloader.Try
- tryCall(Callable<V>) - Static method in class org.dataloader.Try
-
Calls the callable and if it returns a value, the Try is successful with that value or if throws and exception the Try captures that
- tryFuture(CompletionStage<V>) - Static method in class org.dataloader.Try
-
Creates a CompletableFuture that, when it completes, will capture into a Try whether the given completionStage was successful or not
- tryStage(CompletionStage<V>) - Static method in class org.dataloader.Try
-
Creates a CompletionStage that, when it completes, will capture into a Try whether the given completionStage was successful or not
U
- unregister(String) - Method in class org.dataloader.DataLoaderRegistry
-
This will unregister a new dataloader
V
- value - Variable in class org.dataloader.DataLoaderHelper.LoaderQueueEntry
- value - Variable in class org.dataloader.Try
- value() - Element in annotation type org.dataloader.annotations.GuardedBy
-
The lock that should be held.
- valueCache - Variable in class org.dataloader.DataLoader
- valueCache - Variable in class org.dataloader.DataLoaderHelper
- valueCache - Variable in class org.dataloader.DataLoaderOptions
- valueCache() - Method in class org.dataloader.DataLoaderOptions
-
Gets the (optional) cache store implementation that is used for value caching, if caching is enabled.
- ValueCache<K,
V> - Interface in org.dataloader -
The
ValueCache
is used by data loaders that use caching and want a long-lived or external cache of values. - ValueCache.ValueCachingNotSupported - Exception Class in org.dataloader
-
This special exception can be used to short-circuit a caching method
- valueCacheOptions - Variable in class org.dataloader.DataLoaderOptions
- ValueCacheOptions - Class in org.dataloader
-
Options that control how the
ValueCache
is used byDataLoader
- ValueCacheOptions() - Constructor for class org.dataloader.ValueCacheOptions
- ValueCacheOptions(boolean) - Constructor for class org.dataloader.ValueCacheOptions
- ValueCachingNotSupported() - Constructor for exception class org.dataloader.ValueCache.ValueCachingNotSupported
- VisibleForTesting - Annotation Type in org.dataloader.annotations
-
Marks fields, methods etc as more visible than actually needed for testing purposes.
Z
- ZERO_STATS - Static variable in class org.dataloader.stats.NoOpStatisticsCollector
All Classes and Interfaces|All Packages|Serialized Form
DataLoaderFactory
instead