A B C D E F G I J K L M N O P R S T U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- add(DataLoaderInstrumentation) - Method in class org.dataloader.instrumentation.ChainedDataLoaderInstrumentation
-
Adds a new
DataLoaderInstrumentationto the list and creates a newChainedDataLoaderInstrumentation - addAll(Collection<DataLoaderInstrumentation>) - Method in class org.dataloader.instrumentation.ChainedDataLoaderInstrumentation
-
Adds a collection of
DataLoaderInstrumentationto the list and creates a newChainedDataLoaderInstrumentation - allOf(CompletionStage<T>, CompletionStage<T>) - Static method in interface org.dataloader.impl.PromisedValues
-
Returns a new
PromisedValuesthat is completed when all the givenCompletionStages complete. - allOf(CompletionStage<T>, CompletionStage<T>, CompletionStage<T>) - Static method in interface org.dataloader.impl.PromisedValues
-
Returns a new
PromisedValuesthat is completed when all the givenCompletionStages complete. - allOf(CompletionStage<T>, CompletionStage<T>, CompletionStage<T>, CompletionStage<T>) - Static method in interface org.dataloader.impl.PromisedValues
-
Returns a new
PromisedValuesthat is completed when all the givenCompletionStages complete. - allOf(List<? extends CompletionStage<T>>) - Static method in interface org.dataloader.impl.PromisedValues
-
Returns a new
PromisedValuesthat is completed when all the givenCompletionStages complete. - allOf(List<CompletableFuture<T>>) - Static method in class org.dataloader.impl.CompletableFutureKit
- allOf(Map<K, CompletableFuture<V>>) - Static method in class org.dataloader.impl.CompletableFutureKit
- allPromisedValues(List<PromisedValues<T>>) - Static method in interface org.dataloader.impl.PromisedValues
-
Returns a new
PromisedValuesthat is completed when all the givenPromisedValuess complete. - allPromisedValues(PromisedValues<T>, PromisedValues<T>) - Static method in interface org.dataloader.impl.PromisedValues
-
Returns a new
PromisedValuesthat is completed when all the givenPromisedValuess complete. - allPromisedValues(PromisedValues<T>, PromisedValues<T>, PromisedValues<T>) - Static method in interface org.dataloader.impl.PromisedValues
-
Returns a new
PromisedValuesthat is completed when all the givenPromisedValuess complete. - allPromisedValues(PromisedValues<T>, PromisedValues<T>, PromisedValues<T>, PromisedValues<T>) - Static method in interface org.dataloader.impl.PromisedValues
-
Returns a new
PromisedValuesthat is completed when all the givenPromisedValuess complete. - alwaysFailed() - Static method in class org.dataloader.Try
-
This returns a Try that has always failed with a 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
- assertState(boolean, Supplier<String>) - Static method in class org.dataloader.impl.Assertions
B
- batchingEnabled() - Method in class org.dataloader.DataLoaderOptions
-
Option that determines whether to use batching (the default), or not.
- 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
DataLoadercode to provide overall calling context to theBatchLoadercall. - BatchLoaderEnvironment - Class in org.dataloader
-
This object is passed to a batch loader as calling context.
- BatchLoaderEnvironment.Builder - Class in org.dataloader
- BatchLoaderEnvironmentProvider - Interface in org.dataloader
-
A BatchLoaderEnvironmentProvider is used by the
DataLoadercode to provideBatchLoaderEnvironmentcalling context to theBatchLoadercall. - BatchLoaderScheduler - Interface in org.dataloader.scheduler
-
By default, when
DataLoader.dispatch()is called, theBatchLoader/MappedBatchLoaderfunction will be invoked immediately. - BatchLoaderScheduler.ScheduledBatchLoaderCall<V> - Interface in org.dataloader.scheduler
-
This represents a callback that will invoke a
BatchLoaderfunction under the covers - BatchLoaderScheduler.ScheduledBatchPublisherCall - Interface in org.dataloader.scheduler
-
This represents a callback that will invoke a
BatchPublisherorMappedBatchPublisherfunction under the covers - BatchLoaderScheduler.ScheduledMappedBatchLoaderCall<K,V> - Interface in org.dataloader.scheduler
-
This represents a callback that will invoke a
MappedBatchLoaderfunction under the covers - BatchLoaderWithContext<K,V> - Interface in org.dataloader
-
This form of
BatchLoaderis given aBatchLoaderEnvironmentobject that encapsulates the calling context. - batchLoadFunction(Object) - Method in class org.dataloader.DataLoaderFactory.Builder
- BatchPublisher<K,V> - Interface in org.dataloader
-
A function that is invoked for batch loading a stream of data values indicated by the provided list of keys.
- BatchPublisherWithContext<K,V> - Interface in org.dataloader
-
This form of
BatchPublisheris given aBatchLoaderEnvironmentobject that encapsulates the calling context. - batchSubscriber(CompletableFuture<List<V>>, List<K>, List<Object>, List<CompletableFuture<V>>, ReactiveSupport.HelperIntegration<K>) - Static method in class org.dataloader.reactive.ReactiveSupport
- beginBatchLoader(DataLoader<?, ?>, List<?>, BatchLoaderEnvironment) - Method in class org.dataloader.instrumentation.ChainedDataLoaderInstrumentation
- beginBatchLoader(DataLoader<?, ?>, List<?>, BatchLoaderEnvironment) - Method in interface org.dataloader.instrumentation.DataLoaderInstrumentation
-
This call back is done just before the `batch loader` of a
DataLoaderis invoked. - beginDispatch(DataLoader<?, ?>) - Method in class org.dataloader.instrumentation.ChainedDataLoaderInstrumentation
- beginDispatch(DataLoader<?, ?>) - Method in interface org.dataloader.instrumentation.DataLoaderInstrumentation
-
This call back is done just before the
DataLoader.dispatch()is invoked, and it completes when the dispatch call promise is done. - beginLoad(DataLoader<?, ?>, Object, Object) - Method in class org.dataloader.instrumentation.ChainedDataLoaderInstrumentation
- beginLoad(DataLoader<?, ?>, Object, Object) - Method in interface org.dataloader.instrumentation.DataLoaderInstrumentation
-
This call back is done just before the
DataLoader.load(Object)methods are invoked, and it completes when the load promise is completed. - build() - Method in class org.dataloader.BatchLoaderEnvironment.Builder
- build() - Method in class org.dataloader.DataLoaderFactory.Builder
- build() - Method in class org.dataloader.DataLoaderOptions.Builder
- build() - Method in class org.dataloader.DataLoaderRegistry.Builder
- build() - Method in class org.dataloader.registries.ScheduledDataLoaderRegistry.Builder
- builder() - Static method in class org.dataloader.DataLoaderFactory
-
Return a new
DataLoaderFactory.Builderof a data loader. - builder(DataLoader<K, V>) - Static method in class org.dataloader.DataLoaderFactory
-
Return a new
DataLoaderFactory.Builderof a data loader using the specified one as a template. - Builder() - Constructor for class org.dataloader.DataLoaderOptions.Builder
- Builder() - Constructor for class org.dataloader.DataLoaderRegistry.Builder
- Builder() - Constructor for class org.dataloader.registries.ScheduledDataLoaderRegistry.Builder
C
- CacheKey<K> - Interface in org.dataloader
-
Function that is invoked on input keys of type
Kto derive keys that are required by theCacheMapimplementation. - cacheKeyFunction() - Method in class org.dataloader.DataLoaderOptions
-
Gets an (optional) function to invoke for creation of the cache key, if caching is enabled.
- 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() - Method in class org.dataloader.DataLoaderOptions
-
Option that determines whether to use caching of futures (the default), or not.
- cachingExceptionsEnabled() - Method in class org.dataloader.DataLoaderOptions
-
Option that determines whether to cache exceptional values (the default), or not.
- 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
- ChainedDataLoaderInstrumentation - Class in org.dataloader.instrumentation
-
This
DataLoaderInstrumentationcan chain together multiple instrumentations and have them all called in the order of the provided list. - ChainedDataLoaderInstrumentation() - Constructor for class org.dataloader.instrumentation.ChainedDataLoaderInstrumentation
- ChainedDataLoaderInstrumentation(List<DataLoaderInstrumentation>) - Constructor for class org.dataloader.instrumentation.ChainedDataLoaderInstrumentation
- 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) - Method in class org.dataloader.DelegatingDataLoader
- 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.
- clear(K, BiConsumer<Void, Throwable>) - Method in class org.dataloader.DelegatingDataLoader
- clearAll() - Method in class org.dataloader.DataLoader
-
Clears the entire cache map of the loader.
- clearAll() - Method in class org.dataloader.DelegatingDataLoader
- clearAll(BiConsumer<Void, Throwable>) - Method in class org.dataloader.DataLoader
-
Clears the entire cache map of the loader, and of the cached value store.
- clearAll(BiConsumer<Void, Throwable>) - Method in class org.dataloader.DelegatingDataLoader
- clearCacheEntriesOnExceptions(List<K>) - Method in interface org.dataloader.reactive.ReactiveSupport.HelperIntegration
- clearCacheView(K) - Method in interface org.dataloader.reactive.ReactiveSupport.HelperIntegration
- close() - Method in class org.dataloader.registries.ScheduledDataLoaderRegistry
-
Once closed this registry will never again reschedule checks
- 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(DataLoaderRegistry) - Method in class org.dataloader.registries.ScheduledDataLoaderRegistry
-
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
- 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(Object) - Method in class org.dataloader.BatchLoaderEnvironment.Builder
- ctxOrNoopCtx(DataLoaderInstrumentationContext<T>) - Static method in class org.dataloader.instrumentation.DataLoaderInstrumentationHelper
-
Check the
DataLoaderInstrumentationContextto see if its null and returns a noop if it is or else the original context.
D
- 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(BatchLoader<K, V>) - Constructor for class org.dataloader.DataLoader
-
Deprecated.use
DataLoaderFactoryinstead - DataLoader(BatchLoader<K, V>, DataLoaderOptions) - Constructor for class org.dataloader.DataLoader
-
Deprecated.use
DataLoaderFactoryinstead - DataLoaderAssertionException - Exception in org.dataloader.impl
- DataLoaderAssertionException(String) - Constructor for exception org.dataloader.impl.DataLoaderAssertionException
- DataLoaderFactory - Class in org.dataloader
-
A factory class to create
DataLoaders - DataLoaderFactory() - Constructor for class org.dataloader.DataLoaderFactory
- DataLoaderFactory.Builder<K,V> - Class in org.dataloader
-
A builder of
DataLoaders - DataLoaderInstrumentation - Interface in org.dataloader.instrumentation
-
This interface is called when certain actions happen inside a data loader
- DataLoaderInstrumentationContext<T> - Interface in org.dataloader.instrumentation
-
When a
DataLoaderInstrumentation.'beginXXX()' method is called then it must return aDataLoaderInstrumentationContextthat will be invoked when the step is first dispatched and then when it completes. - DataLoaderInstrumentationHelper - Class in org.dataloader.instrumentation
- DataLoaderInstrumentationHelper() - Constructor for class org.dataloader.instrumentation.DataLoaderInstrumentationHelper
- DataLoaderOptions - Class in org.dataloader
-
Configuration options for
DataLoaderinstances. - 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.
- DataLoaderOptions.Builder - Class in org.dataloader
- 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(Map<String, DataLoader<?, ?>>, DataLoaderInstrumentation) - Constructor for class org.dataloader.DataLoaderRegistry
- DataLoaderRegistry.Builder - Class in org.dataloader
- dataLoaders - Variable in class org.dataloader.DataLoaderRegistry
- DefaultCacheMap<K,V> - Class in org.dataloader.impl
-
Default implementation of
CacheMapthat is based on a regularHashMap. - 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.
- delegate - Variable in class org.dataloader.DelegatingDataLoader
- DelegatingDataLoader<K,V> - Class in org.dataloader
-
This delegating
DataLoadermakes it easier to create wrappers ofDataLoaders in case you want to change how values are returned for example. - DelegatingDataLoader(DataLoader<K, V>) - Constructor for class org.dataloader.DelegatingDataLoader
- 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.
- 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.DelegatingDataLoader
- DISPATCH_ALWAYS - Static variable in interface org.dataloader.registries.DispatchPredicate
-
A predicate that always returns true
- DISPATCH_NEVER - Static variable in interface org.dataloader.registries.DispatchPredicate
-
A predicate that always returns false
- dispatchAll() - Method in class org.dataloader.DataLoaderRegistry
-
This will be called
DataLoader.dispatch()on each of the registeredDataLoaders - dispatchAll() - Method in class org.dataloader.registries.ScheduledDataLoaderRegistry
- dispatchAllImmediately() - Method in class org.dataloader.registries.ScheduledDataLoaderRegistry
-
This will immediately dispatch the
DataLoaders in the registry without testing the predicates - dispatchAllWithCount() - Method in class org.dataloader.DataLoaderRegistry
-
Similar to
DataLoaderRegistry.dispatchAll(), this callsDataLoader.dispatch()on each of the registeredDataLoaders, 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
DataLoaders in the registry without testing the predicates - 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. - dispatchAndJoin() - Method in class org.dataloader.DelegatingDataLoader
- dispatchDepth() - Method in class org.dataloader.DataLoader
- dispatchDepth() - Method in class org.dataloader.DataLoaderRegistry
- dispatchDepth() - Method in class org.dataloader.DelegatingDataLoader
- 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
DataLoaderhas not been dispatched for at least the duration length of time. - dispatchPredicate(DispatchPredicate) - Method in class org.dataloader.registries.ScheduledDataLoaderRegistry.Builder
-
This sets a default predicate on the
DataLoaderRegistrythat will control whether allDataLoaders in theDataLoaderRegistryshould be dispatched. - DispatchPredicate - Interface in org.dataloader.registries
-
A predicate class used by
ScheduledDataLoaderRegistryto decide whether to dispatch or not - 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.
- dispatchWithCounts() - Method in class org.dataloader.DelegatingDataLoader
E
- equals(Object) - Method 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 org.dataloader.ValueCache.ValueCachingNotSupported
- flatMap(Function<? super V, Try<U>>) - Method in class org.dataloader.Try
-
Flats maps the Try into another Try type
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
- getBatchLoaderScheduler() - Method in class org.dataloader.DataLoaderOptions
- getBatchLoadExceptionCount() - Method in class org.dataloader.stats.Statistics
- getBatchLoadExceptionRatio() - Method in class org.dataloader.stats.Statistics
- getBatchLoadFunction() - Method in class org.dataloader.DataLoader
- 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.DelegatingDataLoader
- getCacheMap() - Method in class org.dataloader.DataLoader
-
Gets the cacheMap associated with this data loader passed in via
DataLoaderOptions.cacheMap() - getCacheMap() - Method in class org.dataloader.DelegatingDataLoader
- getCacheMissCount() - Method in class org.dataloader.stats.Statistics
- 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
- getDataLoaderPredicates() - Method in class org.dataloader.registries.ScheduledDataLoaderRegistry
- getDataLoaders() - Method in class org.dataloader.DataLoaderRegistry
- getDataLoadersMap() - Method in class org.dataloader.DataLoaderRegistry
- getDelegate() - Method in class org.dataloader.DelegatingDataLoader
- getDelegateStatistics() - Method in class org.dataloader.stats.DelegatingStatisticsCollector
- getDispatchPredicate() - Method in class org.dataloader.registries.ScheduledDataLoaderRegistry
-
There is a default predicate that applies to the whole
ScheduledDataLoaderRegistry - 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.DelegatingDataLoader
- 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.DelegatingDataLoader
- getInstrumentation() - Method in class org.dataloader.DataLoaderOptions
- getInstrumentation() - Method in class org.dataloader.DataLoaderRegistry
- getInstrumentations() - Method in class org.dataloader.instrumentation.ChainedDataLoaderInstrumentation
- 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.DelegatingDataLoader
- getLoadCount() - Method in class org.dataloader.stats.Statistics
- getLoadErrorCount() - Method in class org.dataloader.stats.Statistics
- getLoadErrorRatio() - Method in class org.dataloader.stats.Statistics
- getOptions() - Method in class org.dataloader.DataLoader
- 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
- getScheduledExecutorService() - Method in class org.dataloader.registries.ScheduledDataLoaderRegistry
- 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.DelegatingDataLoader
- 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
- getStats() - Method in interface org.dataloader.reactive.ReactiveSupport.HelperIntegration
- getThrowable() - Method in class org.dataloader.Try
- getTimeSinceDispatch() - Method in class org.dataloader.DataLoader
-
This returns the
Durationsince the data loader was dispatched. - getTimeSinceDispatch() - Method in class org.dataloader.DelegatingDataLoader
- getValueCache() - Method in class org.dataloader.DataLoader
-
Gets the valueCache associated with this data loader passed in via
DataLoaderOptions.valueCache() - getValueCache() - Method in class org.dataloader.DelegatingDataLoader
- 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.
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
- instrumentation - Variable in class org.dataloader.DataLoaderRegistry
- instrumentation(DataLoaderInstrumentation) - Method in class org.dataloader.DataLoaderRegistry.Builder
- instrumentation(DataLoaderInstrumentation) - Method in class org.dataloader.registries.ScheduledDataLoaderRegistry.Builder
- 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.
- invoke() - Method in interface org.dataloader.scheduler.BatchLoaderScheduler.ScheduledBatchLoaderCall
- invoke() - Method in interface org.dataloader.scheduler.BatchLoaderScheduler.ScheduledBatchPublisherCall
- invoke() - Method in interface org.dataloader.scheduler.BatchLoaderScheduler.ScheduledMappedBatchLoaderCall
- isCompleteValueAfterCacheSet() - Method in class org.dataloader.ValueCacheOptions
-
This controls whether the
DataLoaderwill 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
PromisedValueshas completed) - isDone() - Method in class org.dataloader.impl.PromisedValuesImpl
- isFailure() - Method in class org.dataloader.Try
- isSuccess() - Method in class org.dataloader.Try
- isTickerMode() - Method in class org.dataloader.registries.ScheduledDataLoaderRegistry
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
- keyContexts(List<K>, List<Object>) - Method in class org.dataloader.BatchLoaderEnvironment.Builder
L
- 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.DelegatingDataLoader
-
The
DataLoader.load(Object)andDataLoader.loadMany(List)type methods all call back to theDataLoader.load(Object, Object)and hence we don't override them. - 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(List<K>, Subscriber<Map.Entry<K, V>>, BatchLoaderEnvironment) - Method in interface org.dataloader.MappedBatchPublisherWithContext
-
Called to batch the provided keys into a stream of map entries of keys and values.
- load(List<K>, Subscriber<V>) - Method in interface org.dataloader.BatchPublisher
-
Called to batch the provided keys into a stream of values.
- load(List<K>, Subscriber<V>, BatchLoaderEnvironment) - Method in interface org.dataloader.BatchPublisherWithContext
-
Called to batch the provided keys into a stream 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(Set<K>, Subscriber<Map.Entry<K, V>>) - Method in interface org.dataloader.MappedBatchPublisher
-
Called to batch the provided keys into a stream of map entries of keys and 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.
- 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.
- loadMany(Map<K, ?>) - Method in class org.dataloader.DataLoader
-
Requests to load the map 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 data values indicated by the provided set of keys.
- MappedBatchLoaderWithContext<K,V> - Interface in org.dataloader
-
This form of
MappedBatchLoaderis given aBatchLoaderEnvironmentobject that encapsulates the calling context. - MappedBatchPublisher<K,V> - Interface in org.dataloader
-
A function that is invoked for batch loading a stream of data values indicated by the provided list of keys.
- MappedBatchPublisherWithContext<K,V> - Interface in org.dataloader
-
This form of
MappedBatchPublisheris given aBatchLoaderEnvironmentobject that encapsulates the calling context. - mappedBatchSubscriber(CompletableFuture<List<V>>, List<K>, List<Object>, List<CompletableFuture<V>>, ReactiveSupport.HelperIntegration<K>) - Static method in class org.dataloader.reactive.ReactiveSupport
- maxBatchSize() - Method in class org.dataloader.DataLoaderOptions
-
Gets the maximum number of keys that will be presented to the
BatchLoaderfunction before they are split into multiple class
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
DataLoaderFactoryinstead - 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
DataLoaderFactoryinstead - 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
DataLoaderFactoryinstead - 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
DataLoaderFactoryinstead - 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
- newDataLoaderOptions(DataLoaderOptions) - Static method in class org.dataloader.DataLoaderOptions
- newDataLoaderWithTry(BatchLoader<K, Try<V>>) - Static method in class org.dataloader.DataLoader
-
Deprecated.use
DataLoaderFactoryinstead - 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
Tryobjects. - newDataLoaderWithTry(BatchLoader<K, Try<V>>, DataLoaderOptions) - Static method in class org.dataloader.DataLoader
-
Deprecated.use
DataLoaderFactoryinstead - 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
Tryobjects. - newDataLoaderWithTry(BatchLoaderWithContext<K, Try<V>>) - Static method in class org.dataloader.DataLoader
-
Deprecated.use
DataLoaderFactoryinstead - 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
Tryobjects. - newDataLoaderWithTry(BatchLoaderWithContext<K, Try<V>>, DataLoaderOptions) - Static method in class org.dataloader.DataLoader
-
Deprecated.use
DataLoaderFactoryinstead - 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
Tryobjects. - newMappedDataLoader(MappedBatchLoader<K, V>) - Static method in class org.dataloader.DataLoader
-
Deprecated.use
DataLoaderFactoryinstead - 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
DataLoaderFactoryinstead - 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
DataLoaderFactoryinstead - 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
DataLoaderFactoryinstead - 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
DataLoaderFactoryinstead - 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
Tryobjects. - newMappedDataLoaderWithTry(MappedBatchLoader<K, Try<V>>, DataLoaderOptions) - Static method in class org.dataloader.DataLoader
-
Deprecated.use
DataLoaderFactoryinstead - 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
Tryobjects. - newMappedDataLoaderWithTry(MappedBatchLoaderWithContext<K, Try<V>>) - Static method in class org.dataloader.DataLoader
-
Deprecated.use
DataLoaderFactoryinstead - 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
Tryobjects. - newMappedDataLoaderWithTry(MappedBatchLoaderWithContext<K, Try<V>>, DataLoaderOptions) - Static method in class org.dataloader.DataLoader
-
Deprecated.use
DataLoaderFactoryinstead - 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
Tryobjects. - newMappedPublisherDataLoader(MappedBatchPublisher<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).
- newMappedPublisherDataLoader(MappedBatchPublisher<K, V>, DataLoaderOptions) - Static method in class org.dataloader.DataLoaderFactory
-
Creates new DataLoader with the specified batch loader function with the provided options
- newMappedPublisherDataLoader(MappedBatchPublisherWithContext<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).
- newMappedPublisherDataLoader(MappedBatchPublisherWithContext<K, V>, DataLoaderOptions) - Static method in class org.dataloader.DataLoaderFactory
-
Creates new DataLoader with the specified batch loader function with the provided options
- newMappedPublisherDataLoaderWithTry(MappedBatchPublisher<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
Tryobjects. - newMappedPublisherDataLoaderWithTry(MappedBatchPublisher<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
Tryobjects. - newMappedPublisherDataLoaderWithTry(MappedBatchPublisherWithContext<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
Tryobjects. - newMappedPublisherDataLoaderWithTry(MappedBatchPublisherWithContext<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
Tryobjects. - newOptions() - Static method in class org.dataloader.DataLoaderOptions
- newOptions() - Static method in class org.dataloader.ValueCacheOptions
- newOptionsBuilder() - Static method in class org.dataloader.DataLoaderOptions
- newPublisherDataLoader(BatchPublisher<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).
- newPublisherDataLoader(BatchPublisher<K, V>, DataLoaderOptions) - Static method in class org.dataloader.DataLoaderFactory
-
Creates new DataLoader with the specified batch loader function with the provided options
- newPublisherDataLoader(BatchPublisherWithContext<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).
- newPublisherDataLoader(BatchPublisherWithContext<K, V>, DataLoaderOptions) - Static method in class org.dataloader.DataLoaderFactory
-
Creates new DataLoader with the specified batch loader function with the provided options
- newPublisherDataLoaderWithTry(BatchPublisher<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
Tryobjects. - newPublisherDataLoaderWithTry(BatchPublisher<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
Tryobjects. - newPublisherDataLoaderWithTry(BatchPublisherWithContext<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
Tryobjects. - newPublisherDataLoaderWithTry(BatchPublisherWithContext<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
Tryobjects. - 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 milliseconds. - 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
- NOOP_INSTRUMENTATION - Static variable in class org.dataloader.instrumentation.DataLoaderInstrumentationHelper
-
A well known noop
DataLoaderInstrumentation - noOpCtx() - Static method in class org.dataloader.instrumentation.DataLoaderInstrumentationHelper
-
Returns a noop
DataLoaderInstrumentationContextof the right type - 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
ValueCachethat does nothing. - NoOpValueCache() - Constructor for class org.dataloader.impl.NoOpValueCache
O
- onCompleted(T, Throwable) - Method in interface org.dataloader.instrumentation.DataLoaderInstrumentationContext
-
This is invoked when the instrumentation step is fully completed.
- onDispatched() - Method in interface org.dataloader.instrumentation.DataLoaderInstrumentationContext
-
This is invoked when the instrumentation step is initially dispatched.
- options(DataLoaderOptions) - Method in class org.dataloader.DataLoaderFactory.Builder
- 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.instrumentation - package org.dataloader.instrumentation
- org.dataloader.reactive - package org.dataloader.reactive
- org.dataloader.registries - package org.dataloader.registries
- org.dataloader.scheduler - package org.dataloader.scheduler
- org.dataloader.stats - package org.dataloader.stats
- org.dataloader.stats.context - package org.dataloader.stats.context
P
- prepend(DataLoaderInstrumentation) - Method in class org.dataloader.instrumentation.ChainedDataLoaderInstrumentation
-
Prepends a new
DataLoaderInstrumentationto the list and creates a newChainedDataLoaderInstrumentation - prime(K, Exception) - Method in class org.dataloader.DataLoader
-
Primes the cache with the given key and error.
- prime(K, Exception) - Method in class org.dataloader.DelegatingDataLoader
- prime(K, CompletableFuture<V>) - Method in class org.dataloader.DataLoader
-
Primes the cache with the given key and value.
- prime(K, CompletableFuture<V>) - Method in class org.dataloader.DelegatingDataLoader
- prime(K, V) - Method in class org.dataloader.DataLoader
-
Primes the cache with the given key and value.
- prime(K, V) - Method in class org.dataloader.DelegatingDataLoader
- PromisedValues<T> - Interface in org.dataloader.impl
-
This allows multiple
CompletionStages to be combined and completed as one and should something go wrong, instead of throwingCompletionExceptions it captures the cause and returns null for that data value, otherwise it allows you to access them as a list of values. - PromisedValuesImpl<T> - Class in org.dataloader.impl
- 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.
R
- ratio(long, long) - Method in class org.dataloader.stats.Statistics
-
A helper to divide two numbers and handle zero
- ReactiveSupport - Class in org.dataloader.reactive
- ReactiveSupport() - Constructor for class org.dataloader.reactive.ReactiveSupport
- ReactiveSupport.HelperIntegration<K> - Interface in org.dataloader.reactive
-
Just some callbacks to the data loader code to do common tasks
- 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
- register(String, DataLoader<?, ?>, DispatchPredicate) - Method in class org.dataloader.registries.ScheduledDataLoaderRegistry.Builder
-
This will register a new dataloader with a specific
DispatchPredicate - register(String, DataLoader<?, ?>, DispatchPredicate) - Method in class org.dataloader.registries.ScheduledDataLoaderRegistry
-
This will register a new dataloader and dispatch predicate associated with that data loader
- registerAll(DataLoaderRegistry) - Method in class org.dataloader.DataLoaderRegistry.Builder
-
This will combine 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 the data loaders in this builder with the ones from a previous
DataLoaderRegistry - 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(Duration) - Method in class org.dataloader.registries.ScheduledDataLoaderRegistry.Builder
- scheduleBatchLoader(BatchLoaderScheduler.ScheduledBatchLoaderCall<V>, List<K>, BatchLoaderEnvironment) - Method in interface org.dataloader.scheduler.BatchLoaderScheduler
-
This is called to schedule a
BatchLoadercall. - scheduleBatchPublisher(BatchLoaderScheduler.ScheduledBatchPublisherCall, List<K>, BatchLoaderEnvironment) - Method in interface org.dataloader.scheduler.BatchLoaderScheduler
-
This is called to schedule a
BatchPublishercall. - ScheduledDataLoaderRegistry - Class in org.dataloader.registries
-
This
DataLoaderRegistrywill useDispatchPredicates whenScheduledDataLoaderRegistry.dispatchAll()is called to test (for eachDataLoaderin the registry) if a dispatch should proceed. - ScheduledDataLoaderRegistry.Builder - Class in org.dataloader.registries
- scheduledExecutorService(ScheduledExecutorService) - Method in class org.dataloader.registries.ScheduledDataLoaderRegistry.Builder
-
If you provide a
ScheduledExecutorServicethen it will NOT be shutdown whenScheduledDataLoaderRegistry.close()is called. - scheduleMappedBatchLoader(BatchLoaderScheduler.ScheduledMappedBatchLoaderCall<K, V>, List<K>, BatchLoaderEnvironment) - Method in interface org.dataloader.scheduler.BatchLoaderScheduler
-
This is called to schedule a
MappedBatchLoadercall. - 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.Builder
- 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.Builder
- 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
- setBatchLoaderScheduler(BatchLoaderScheduler) - Method in class org.dataloader.DataLoaderOptions.Builder
- setBatchLoaderScheduler(BatchLoaderScheduler) - Method in class org.dataloader.DataLoaderOptions
-
Sets in a new
BatchLoaderSchedulerthat allows the call to aBatchLoaderfunction to be scheduled to some future time. - setCacheKeyFunction(CacheKey<?>) - Method in class org.dataloader.DataLoaderOptions.Builder
- 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.Builder
- 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.Builder
- 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.Builder
- setCachingExceptionsEnabled(boolean) - Method in class org.dataloader.DataLoaderOptions
-
Sets the option that determines whether exceptional values are cache enabled.
- setCompleteValueAfterCacheSet(boolean) - Method in class org.dataloader.ValueCacheOptions
- setInstrumentation(DataLoaderInstrumentation) - Method in class org.dataloader.DataLoaderOptions.Builder
- setInstrumentation(DataLoaderInstrumentation) - Method in class org.dataloader.DataLoaderOptions
-
Sets in a new
DataLoaderInstrumentation - setMaxBatchSize(int) - Method in class org.dataloader.DataLoaderOptions.Builder
- setMaxBatchSize(int) - Method in class org.dataloader.DataLoaderOptions
-
Sets the maximum number of keys that will be presented to the
BatchLoaderfunction before they are split into multiple class - setStatisticsCollector(Supplier<StatisticsCollector>) - Method in class org.dataloader.DataLoaderOptions.Builder
- setStatisticsCollector(Supplier<StatisticsCollector>) - Method in class org.dataloader.DataLoaderOptions
-
Sets the statistics collector supplier that will be used with these data loader options.
- setValueCache(ValueCache<?, ?>) - Method in class org.dataloader.DataLoaderOptions.Builder
- 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.Builder
- setValueCacheOptions(ValueCacheOptions) - Method in class org.dataloader.DataLoaderOptions
-
Sets the
ValueCacheOptionsthat control how theValueCachewill 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
AtomicLongs 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
- Statistics - Class in org.dataloader.stats
-
This holds statistics on how a
DataLoaderhas 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 - Interface in org.dataloader.stats
-
This allows statistics to be collected for
DataLoaderoperations - 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
CompletionStageat 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
PromisedValuesas 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
- tickerMode(boolean) - Method in class org.dataloader.registries.ScheduledDataLoaderRegistry.Builder
-
This sets ticker mode on the registry.
- 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
- transform(Consumer<DataLoaderFactory.Builder<K, V>>) - Method in class org.dataloader.DataLoader
-
This allows you to change the current
DataLoaderand turn it into a new one - transform(Consumer<DataLoaderFactory.Builder<K, V>>) - Method in class org.dataloader.DelegatingDataLoader
- transform(Consumer<DataLoaderOptions.Builder>) - Method in class org.dataloader.DataLoaderOptions
-
Will transform the current options in to a builder ands allow you to build a new set of options
- Try<V> - Class in org.dataloader
-
Try is class that allows you to hold the result of computation or the throwable it produced.
- 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
- unregister(String) - Method in class org.dataloader.registries.ScheduledDataLoaderRegistry
-
This will unregister a new dataloader
- unwrap(DataLoader<K, V>) - Static method in class org.dataloader.DelegatingDataLoader
-
This can be called to unwrap a given
DataLoadersuch that if it's aDelegatingDataLoaderthe underlyingDataLoaderis returned otherwise it's just passed in data loader
V
- value() - Method in annotation type org.dataloader.annotations.GuardedBy
- 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
ValueCacheis used by data loaders that use caching and want a long-lived or external cache of values. - ValueCache.ValueCachingNotSupported - Exception in org.dataloader
-
This special exception can be used to short-circuit a caching method
- ValueCacheOptions - Class in org.dataloader
-
Options that control how the
ValueCacheis used byDataLoader - ValueCachingNotSupported() - Constructor for exception org.dataloader.ValueCache.ValueCachingNotSupported
- VisibleForTesting - Annotation Type in org.dataloader.annotations
-
Marks fields, methods etc.
W
- whenCompleted(BiConsumer<U, Throwable>) - Static method in class org.dataloader.instrumentation.DataLoaderInstrumentationHelper
-
Allows for the more fluent away to return an instrumentation context that runs the specified code on instrumentation step completion.
- whenDispatched(Runnable) - Static method in class org.dataloader.instrumentation.DataLoaderInstrumentationHelper
-
Allows for the more fluent away to return an instrumentation context that runs the specified code on instrumentation step dispatch.
All Classes All Packages