Class DataLoaderFactory

java.lang.Object
org.dataloader.DataLoaderFactory

@PublicApi public class DataLoaderFactory extends Object
A factory class to create DataLoaders
  • Constructor Details

    • DataLoaderFactory

      public DataLoaderFactory()
  • Method Details

    • 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 its 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:
    • 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 its 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:
    • 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 its 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:
    • 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 its 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:
    • mkDataLoader

      static <K, V> DataLoader<K,V> mkDataLoader(Object batchLoadFunction, DataLoaderOptions options)