A B C D F G I J L M N O P R S T U

A

allOf(List<CompletableFuture<T>>) - Static method in class org.dataloader.impl.CompletableFutureKit

allOf(List<? extends CompletionStage<T>>) - Static method in interface org.dataloader.impl.PromisedValues

Returns a new PromisedValues that is completed when all of the given CompletionStages complete.

allOf(CompletionStage<T>, CompletionStage<T>) - Static method in interface org.dataloader.impl.PromisedValues

Returns a new PromisedValues that is completed when all of the given CompletionStages 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 given CompletionStages 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 given CompletionStages complete.

allPromisedValues(List<PromisedValues<T>>) - Static method in interface org.dataloader.impl.PromisedValues

Returns a new PromisedValues that is completed when all of the given PromisedValuess 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 given PromisedValuess 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 given PromisedValuess 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 given PromisedValuess complete.

Assertions - Class in org.dataloader.impl

Assertions() - Constructor for class org.dataloader.impl.Assertions

assertState(boolean, 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.

beginExecutionStrategy(InstrumentationExecutionStrategyParameters) - Method in class org.dataloader.graphql.DataLoaderDispatcherInstrumentation

C

CacheKey<K> - Interface in org.dataloader

Function that is invoked on input keys of type K to derive keys that are required by the CacheMap implementation.

cacheKeyFunction() - Method in class org.dataloader.DataLoaderOptions

Gets an (optional) function to invoke for creation of the cache key, if caching is enabled.

CacheMap<U,V> - Interface in org.dataloader

Cache map interface for data loaders that use caching.

cacheMap() - Method in class org.dataloader.DataLoaderOptions

Gets the (optional) cache map implementation that is used for caching, if caching is enabled.

cachingEnabled() - Method in class org.dataloader.DataLoaderOptions

Option that determines whether to use caching of futures (the default), or not.

cause(CompletableFuture) - Static method in class org.dataloader.impl.CompletableFutureKit

cause() - Method in interface org.dataloader.impl.PromisedValues

The exception cause or null if it didn't fail

cause(int) - Method in interface org.dataloader.impl.PromisedValues

The exception cause at the specified index or null if it didn't fail

cause() - Method in class org.dataloader.impl.PromisedValuesImpl

cause(int) - Method in class org.dataloader.impl.PromisedValuesImpl

clear() - Method in interface org.dataloader.CacheMap

Clears all entries of the cache map

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() - Method in class org.dataloader.impl.DefaultCacheMap

Clears all entries of the cache map

clearAll() - Method in class org.dataloader.DataLoader

Clears the entire cache map of the loader.

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

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

containsKey(U) - Method in interface org.dataloader.CacheMap

Checks whether the specified key is contained in the cach map.

containsKey(U) - Method in class org.dataloader.impl.DefaultCacheMap

Checks whether the specified key is contained in the cach map.

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

Creates a new data loader with the provided batch load function, and default options.

DataLoader(BatchLoader<K, V>, DataLoaderOptions) - Constructor for class org.dataloader.DataLoader

Creates a new data loader with the provided batch load function and options.

DataLoaderDispatcherInstrumentation - Class in org.dataloader.graphql

This graphql Instrumentation will dispatch all the contained DataLoaders when each level of the graphql query is executed.

DataLoaderDispatcherInstrumentation(DataLoaderRegistry) - Constructor for class org.dataloader.graphql.DataLoaderDispatcherInstrumentation

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

DefaultCacheMap<U,V> - Class in org.dataloader.impl

Default implementation of CacheMap that is based on a regular LinkedHashMap.

DefaultCacheMap() - Constructor for class org.dataloader.impl.DefaultCacheMap

Default constructor

delete(U) - Method in interface org.dataloader.CacheMap

Deletes the entry with the specified key from the cache map, if it exists.

delete(U) - Method in class org.dataloader.impl.DefaultCacheMap

Deletes the entry with the specified key from the cache map, 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.

dispatchAll() - Method in class org.dataloader.DataLoaderRegistry

This will called DataLoader.dispatch() on each of the registered DataLoaders

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

F

failed(CompletableFuture) - Static method in class org.dataloader.impl.CompletableFutureKit

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

failedFuture(Exception) - Static method in class org.dataloader.impl.CompletableFutureKit

flatMap(Function<? super V, Try<U>>) - Method in class org.dataloader.Try

Flats maps the Try into another Try type

G

get(U) - Method in interface org.dataloader.CacheMap

Gets the specified key from the cache map.

get(U) - Method in class org.dataloader.impl.DefaultCacheMap

Gets the specified key from the cache map.

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() - Method in class org.dataloader.Try

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.

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

getKey(K) - Method in interface org.dataloader.CacheKey

Returns the cache key that is created from the provided input key.

getKeys() - Method in class org.dataloader.DataLoaderRegistry

getThrowable() - Method in class org.dataloader.Try

I

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

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

L

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(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.

M

map(Function<? super V, U>) - Method in class org.dataloader.Try

Maps the Try into another Try with a different type

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

N

newDataLoader(BatchLoader<K, V>) - Static method in class org.dataloader.DataLoader

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

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

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

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

nonNull(T) - Static method in class org.dataloader.impl.Assertions

O

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.graphql - package org.dataloader.graphql

org.dataloader.impl - package org.dataloader.impl

P

prime(K, V) - Method in class org.dataloader.DataLoader

Primes the cache with the given key and value.

prime(K, Exception) - Method in class org.dataloader.DataLoader

Primes the cache with the given key and error.

PromisedValues<T> - Interface in org.dataloader.impl

This allows multiple CompletionStages to be combined together and completed as one and should something go wrong, instead of throwing CompletionExceptions 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

R

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

This will register a new dataloader

reThrow() - Method in class org.dataloader.Try

Rethrows the underlying throwable inside the unsuccessful Try

S

set(U, 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(U, 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.

setBatchingEnabled(boolean) - Method in class org.dataloader.DataLoaderOptions

Sets the option that determines whether batch loading is enabled.

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.

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

simpleMap() - Static method in interface org.dataloader.CacheMap

Creates a new cache map, using the default implementation that is based on a LinkedHashMap.

size() - Method in interface org.dataloader.impl.PromisedValues

size() - Method in class org.dataloader.impl.PromisedValuesImpl

succeeded(CompletableFuture) - Static method in class org.dataloader.impl.CompletableFutureKit

succeeded() - Method in interface org.dataloader.impl.PromisedValues

succeeded(int) - Method in interface org.dataloader.impl.PromisedValues

The true if the CompletionStage at the specified index succeeded

succeeded() - Method in class org.dataloader.impl.PromisedValuesImpl

succeeded(int) - Method in class org.dataloader.impl.PromisedValuesImpl

succeeded(V) - Static method in class org.dataloader.Try

Creates a Try that has succeeded with the provided value

T

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

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

toOptional() - Method in class org.dataloader.Try

Converts the Try into an Optional where unsuccessful tries are empty

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

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

A B C D F G I J L M N O P R S T U