Package org.dataloader

Class DataLoaderFactory

  • @PublicApi
public class DataLoaderFactory
extends java.lang.Object
    A factory class to create DataLoaders

    • Constructor Detail

      • DataLoaderFactory

        public DataLoaderFactory()

    • Method Detail

      • newDataLoader

        public static <K,​V> DataLoader<K,​V> newDataLoader​(BatchLoader<K,​V> batchLoadFunction)
        Creates new DataLoader with the specified batch loader function and default options (batching, caching and unlimited batch size).
        Type Parameters:
        K - the key type
        V - the value type
        Parameters:
        batchLoadFunction - the batch load function to use
        Returns:
        a new DataLoader

      • newDataLoader

        public static <K,​V> DataLoader<K,​V> newDataLoader​(BatchLoader<K,​V> batchLoadFunction,
                                                              DataLoaderOptions options)
        Creates new DataLoader with the specified batch loader function with the provided options
        Type Parameters:
        K - the key type
        V - the value type
        Parameters:
        batchLoadFunction - the batch load function to use
        options - the options to use
        Returns:
        a new DataLoader

      • newDataLoaderWithTry

        public static <K,​V> DataLoader<K,​V> newDataLoaderWithTry​(BatchLoader<K,​Try<V>> batchLoadFunction)
        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.

        If it's important you to know the exact status of each item in a batch call and whether it threw exceptions then you can use this form to create the data loader.

        Using Try objects allows you to capture a value returned or an exception that might have occurred trying to get a value. .

        Type Parameters:
        K - the key type
        V - the value type
        Parameters:
        batchLoadFunction - the batch load function to use that uses Try objects
        Returns:
        a new DataLoader

      • newDataLoaderWithTry

        public static <K,​V> DataLoader<K,​V> newDataLoaderWithTry​(BatchLoader<K,​Try<V>> batchLoadFunction,
                                                                     DataLoaderOptions options)
        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.
        Type Parameters:
        K - the key type
        V - the value type
        Parameters:
        batchLoadFunction - the batch load function to use that uses Try objects
        options - the options to use
        Returns:
        a new DataLoader
        See Also:
        newDataLoaderWithTry(BatchLoader)

      • newDataLoader

        public static <K,​V> DataLoader<K,​V> newDataLoader​(BatchLoaderWithContext<K,​V> batchLoadFunction)
        Creates new DataLoader with the specified batch loader function and default options (batching, caching and unlimited batch size).
        Type Parameters:
        K - the key type
        V - the value type
        Parameters:
        batchLoadFunction - the batch load function to use
        Returns:
        a new DataLoader

      • newDataLoader

        public static <K,​V> DataLoader<K,​V> newDataLoader​(BatchLoaderWithContext<K,​V> batchLoadFunction,
                                                              DataLoaderOptions options)
        Creates new DataLoader with the specified batch loader function with the provided options
        Type Parameters:
        K - the key type
        V - the value type
        Parameters:
        batchLoadFunction - the batch load function to use
        options - the options to use
        Returns:
        a new DataLoader

      • newDataLoaderWithTry

        public static <K,​V> DataLoader<K,​V> newDataLoaderWithTry​(BatchLoaderWithContext<K,​Try<V>> batchLoadFunction)
        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.

        If it's important you to know the exact status of each item in a batch call and whether it threw exceptions then you can use this form to create the data loader.

        Using Try objects allows you to capture a value returned or an exception that might have occurred trying to get a value. .

        Type Parameters:
        K - the key type
        V - the value type
        Parameters:
        batchLoadFunction - the batch load function to use that uses Try objects
        Returns:
        a new DataLoader

      • newDataLoaderWithTry

        public static <K,​V> DataLoader<K,​V> newDataLoaderWithTry​(BatchLoaderWithContext<K,​Try<V>> batchLoadFunction,
                                                                     DataLoaderOptions options)
        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.
        Type Parameters:
        K - the key type
        V - the value type
        Parameters:
        batchLoadFunction - the batch load function to use that uses Try objects
        options - the options to use
        Returns:
        a new DataLoader
        See Also:
        newDataLoaderWithTry(BatchLoader)

      • newMappedDataLoader

        public static <K,​V> DataLoader<K,​V> newMappedDataLoader​(MappedBatchLoader<K,​V> batchLoadFunction)
        Creates new DataLoader with the specified batch loader function and default options (batching, caching and unlimited batch size).
        Type Parameters:
        K - the key type
        V - the value type
        Parameters:
        batchLoadFunction - the batch load function to use
        Returns:
        a new DataLoader

      • newMappedDataLoader

        public static <K,​V> DataLoader<K,​V> newMappedDataLoader​(MappedBatchLoader<K,​V> batchLoadFunction,
                                                                    DataLoaderOptions options)
        Creates new DataLoader with the specified batch loader function with the provided options
        Type Parameters:
        K - the key type
        V - the value type
        Parameters:
        batchLoadFunction - the batch load function to use
        options - the options to use
        Returns:
        a new DataLoader

      • newMappedDataLoaderWithTry

        public static <K,​V> DataLoader<K,​V> newMappedDataLoaderWithTry​(MappedBatchLoader<K,​Try<V>> batchLoadFunction)
        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.

        If it's important you to know the exact status of each item in a batch call and whether it threw exceptions then you can use this form to create the data loader.

        Using Try objects allows you to capture a value returned or an exception that might have occurred trying to get a value. .

        Type Parameters:
        K - the key type
        V - the value type
        Parameters:
        batchLoadFunction - the batch load function to use that uses Try objects
        Returns:
        a new DataLoader

      • newMappedDataLoaderWithTry

        public static <K,​V> DataLoader<K,​V> newMappedDataLoaderWithTry​(MappedBatchLoader<K,​Try<V>> batchLoadFunction,
                                                                           DataLoaderOptions options)
        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.
        Type Parameters:
        K - the key type
        V - the value type
        Parameters:
        batchLoadFunction - the batch load function to use that uses Try objects
        options - the options to use
        Returns:
        a new DataLoader
        See Also:
        newDataLoaderWithTry(BatchLoader)

      • newMappedDataLoader

        public static <K,​V> DataLoader<K,​V> newMappedDataLoader​(MappedBatchLoaderWithContext<K,​V> batchLoadFunction)
        Creates new DataLoader with the specified mapped batch loader function and default options (batching, caching and unlimited batch size).
        Type Parameters:
        K - the key type
        V - the value type
        Parameters:
        batchLoadFunction - the batch load function to use
        Returns:
        a new DataLoader

      • newMappedDataLoader

        public static <K,​V> DataLoader<K,​V> newMappedDataLoader​(MappedBatchLoaderWithContext<K,​V> batchLoadFunction,
                                                                    DataLoaderOptions options)
        Creates new DataLoader with the specified batch loader function with the provided options
        Type Parameters:
        K - the key type
        V - the value type
        Parameters:
        batchLoadFunction - the batch load function to use
        options - the options to use
        Returns:
        a new DataLoader

      • newMappedDataLoaderWithTry

        public static <K,​V> DataLoader<K,​V> newMappedDataLoaderWithTry​(MappedBatchLoaderWithContext<K,​Try<V>> batchLoadFunction)
        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.

        If it's important you to know the exact status of each item in a batch call and whether it threw exceptions then you can use this form to create the data loader.

        Using Try objects allows you to capture a value returned or an exception that might have occurred trying to get a value. .

        Type Parameters:
        K - the key type
        V - the value type
        Parameters:
        batchLoadFunction - the batch load function to use that uses Try objects
        Returns:
        a new DataLoader

      • newMappedDataLoaderWithTry

        public static <K,​V> DataLoader<K,​V> newMappedDataLoaderWithTry​(MappedBatchLoaderWithContext<K,​Try<V>> batchLoadFunction,
                                                                           DataLoaderOptions options)
        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.
        Type Parameters:
        K - the key type
        V - the value type
        Parameters:
        batchLoadFunction - the batch load function to use that uses Try objects
        options - the options to use
        Returns:
        a new DataLoader
        See Also:
        newDataLoaderWithTry(BatchLoader)

      • newPublisherDataLoader

        public static <K,​V> DataLoader<K,​V> newPublisherDataLoader​(BatchPublisher<K,​V> batchLoadFunction)
        Creates new DataLoader with the specified batch loader function and default options (batching, caching and unlimited batch size).
        Type Parameters:
        K - the key type
        V - the value type
        Parameters:
        batchLoadFunction - the batch load function to use
        Returns:
        a new DataLoader

      • newPublisherDataLoader

        public static <K,​V> DataLoader<K,​V> newPublisherDataLoader​(BatchPublisher<K,​V> batchLoadFunction,
                                                                       DataLoaderOptions options)
        Creates new DataLoader with the specified batch loader function with the provided options
        Type Parameters:
        K - the key type
        V - the value type
        Parameters:
        batchLoadFunction - the batch load function to use
        options - the options to use
        Returns:
        a new DataLoader

      • newPublisherDataLoaderWithTry

        public static <K,​V> DataLoader<K,​V> newPublisherDataLoaderWithTry​(BatchPublisher<K,​Try<V>> batchLoadFunction)
        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.

        If it's important you to know the exact status of each item in a batch call and whether it threw exceptions then you can use this form to create the data loader.

        Using Try objects allows you to capture a value returned or an exception that might have occurred trying to get a value. .

        Type Parameters:
        K - the key type
        V - the value type
        Parameters:
        batchLoadFunction - the batch load function to use that uses Try objects
        Returns:
        a new DataLoader

      • newPublisherDataLoaderWithTry

        public static <K,​V> DataLoader<K,​V> newPublisherDataLoaderWithTry​(BatchPublisher<K,​Try<V>> batchLoadFunction,
                                                                              DataLoaderOptions options)
        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.
        Type Parameters:
        K - the key type
        V - the value type
        Parameters:
        batchLoadFunction - the batch load function to use that uses Try objects
        options - the options to use
        Returns:
        a new DataLoader
        See Also:
        newDataLoaderWithTry(BatchLoader)

      • newPublisherDataLoader

        public static <K,​V> DataLoader<K,​V> newPublisherDataLoader​(BatchPublisherWithContext<K,​V> batchLoadFunction)
        Creates new DataLoader with the specified batch loader function and default options (batching, caching and unlimited batch size).
        Type Parameters:
        K - the key type
        V - the value type
        Parameters:
        batchLoadFunction - the batch load function to use
        Returns:
        a new DataLoader

      • newPublisherDataLoader

        public static <K,​V> DataLoader<K,​V> newPublisherDataLoader​(BatchPublisherWithContext<K,​V> batchLoadFunction,
                                                                       DataLoaderOptions options)
        Creates new DataLoader with the specified batch loader function with the provided options
        Type Parameters:
        K - the key type
        V - the value type
        Parameters:
        batchLoadFunction - the batch load function to use
        options - the options to use
        Returns:
        a new DataLoader

      • newPublisherDataLoaderWithTry

        public static <K,​V> DataLoader<K,​V> newPublisherDataLoaderWithTry​(BatchPublisherWithContext<K,​Try<V>> batchLoadFunction)
        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.

        If it's important you to know the exact status of each item in a batch call and whether it threw exceptions then you can use this form to create the data loader.

        Using Try objects allows you to capture a value returned or an exception that might have occurred trying to get a value. .

        Type Parameters:
        K - the key type
        V - the value type
        Parameters:
        batchLoadFunction - the batch load function to use that uses Try objects
        Returns:
        a new DataLoader

      • newPublisherDataLoaderWithTry

        public static <K,​V> DataLoader<K,​V> newPublisherDataLoaderWithTry​(BatchPublisherWithContext<K,​Try<V>> batchLoadFunction,
                                                                              DataLoaderOptions options)
        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.
        Type Parameters:
        K - the key type
        V - the value type
        Parameters:
        batchLoadFunction - the batch load function to use that uses Try objects
        options - the options to use
        Returns:
        a new DataLoader
        See Also:
        newPublisherDataLoaderWithTry(BatchPublisher)

      • newMappedPublisherDataLoader

        public static <K,​V> DataLoader<K,​V> newMappedPublisherDataLoader​(MappedBatchPublisher<K,​V> batchLoadFunction)
        Creates new DataLoader with the specified batch loader function and default options (batching, caching and unlimited batch size).
        Type Parameters:
        K - the key type
        V - the value type
        Parameters:
        batchLoadFunction - the batch load function to use
        Returns:
        a new DataLoader

      • newMappedPublisherDataLoader

        public static <K,​V> DataLoader<K,​V> newMappedPublisherDataLoader​(MappedBatchPublisher<K,​V> batchLoadFunction,
                                                                             DataLoaderOptions options)
        Creates new DataLoader with the specified batch loader function with the provided options
        Type Parameters:
        K - the key type
        V - the value type
        Parameters:
        batchLoadFunction - the batch load function to use
        options - the options to use
        Returns:
        a new DataLoader

      • newMappedPublisherDataLoaderWithTry

        public static <K,​V> DataLoader<K,​V> newMappedPublisherDataLoaderWithTry​(MappedBatchPublisher<K,​Try<V>> batchLoadFunction)
        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.

        If it's important you to know the exact status of each item in a batch call and whether it threw exceptions then you can use this form to create the data loader.

        Using Try objects allows you to capture a value returned or an exception that might have occurred trying to get a value. .

        Type Parameters:
        K - the key type
        V - the value type
        Parameters:
        batchLoadFunction - the batch load function to use that uses Try objects
        Returns:
        a new DataLoader

      • newMappedPublisherDataLoaderWithTry

        public static <K,​V> DataLoader<K,​V> newMappedPublisherDataLoaderWithTry​(MappedBatchPublisher<K,​Try<V>> batchLoadFunction,
                                                                                    DataLoaderOptions options)
        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.
        Type Parameters:
        K - the key type
        V - the value type
        Parameters:
        batchLoadFunction - the batch load function to use that uses Try objects
        options - the options to use
        Returns:
        a new DataLoader
        See Also:
        newDataLoaderWithTry(BatchLoader)

      • newMappedPublisherDataLoader

        public static <K,​V> DataLoader<K,​V> newMappedPublisherDataLoader​(MappedBatchPublisherWithContext<K,​V> batchLoadFunction)
        Creates new DataLoader with the specified batch loader function and default options (batching, caching and unlimited batch size).
        Type Parameters:
        K - the key type
        V - the value type
        Parameters:
        batchLoadFunction - the batch load function to use
        Returns:
        a new DataLoader

      • newMappedPublisherDataLoader

        public static <K,​V> DataLoader<K,​V> newMappedPublisherDataLoader​(MappedBatchPublisherWithContext<K,​V> batchLoadFunction,
                                                                             DataLoaderOptions options)
        Creates new DataLoader with the specified batch loader function with the provided options
        Type Parameters:
        K - the key type
        V - the value type
        Parameters:
        batchLoadFunction - the batch load function to use
        options - the options to use
        Returns:
        a new DataLoader

      • newMappedPublisherDataLoaderWithTry

        public static <K,​V> DataLoader<K,​V> newMappedPublisherDataLoaderWithTry​(MappedBatchPublisherWithContext<K,​Try<V>> batchLoadFunction)
        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.

        If it's important you to know the exact status of each item in a batch call and whether it threw exceptions then you can use this form to create the data loader.

        Using Try objects allows you to capture a value returned or an exception that might have occurred trying to get a value. .

        Type Parameters:
        K - the key type
        V - the value type
        Parameters:
        batchLoadFunction - the batch load function to use that uses Try objects
        Returns:
        a new DataLoader

      • newMappedPublisherDataLoaderWithTry

        public static <K,​V> DataLoader<K,​V> newMappedPublisherDataLoaderWithTry​(MappedBatchPublisherWithContext<K,​Try<V>> batchLoadFunction,
                                                                                    DataLoaderOptions options)
        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.
        Type Parameters:
        K - the key type
        V - the value type
        Parameters:
        batchLoadFunction - the batch load function to use that uses Try objects
        options - the options to use
        Returns:
        a new DataLoader
        See Also:
        newMappedPublisherDataLoaderWithTry(MappedBatchPublisher)