newGenericCache<T> abstract method

Future<Cache<T>> newGenericCache<T>(
  1. Store<CacheInfo, CacheEntry> store, {
  2. String? name,
  3. dynamic fromEncodable(
    1. Map<String, dynamic>
    )?,
  4. ExpiryPolicy? expiryPolicy,
  5. KeySampler? sampler,
  6. EvictionPolicy? evictionPolicy,
  7. int? maxEntries,
  8. CacheLoader<T>? cacheLoader,
  9. Clock? clock,
  10. EventListenerMode? eventListenerMode,
  11. bool? statsEnabled,
  12. CacheStats? stats,
})

Builds a new Cache

  • store: The Store that will back this Cache
  • name: The name of the cache
  • fromEncodable: The function that converts between the Map representation of the object and the object itself.
  • expiryPolicy: The expiry policy to use, defaults to EternalExpiryPolicy if not provided
  • sampler: The sampler to use upon eviction of a cache element, defaults to FullSampler if not provided
  • evictionPolicy: The eviction policy to use, defaults to LruEvictionPolicy if not provided
  • maxEntries: The max number of entries this cache can hold if provided. To trigger the eviction policy this value should be provided
  • cacheLoader: The CacheLoader that should be used to fetch a new value upon expiration
  • clock: The source of time to be used on this, defaults to the system clock if not provided
  • eventListenerMode: The event listener mode of this cache
  • statsEnabled: If statistics should be collected, defaults to false
  • stats: The statistics instance

Returns a new DefaultCache

Implementation

Future<Cache<T>> newGenericCache<T>(Store<CacheInfo, CacheEntry> store,
    {String? name,
    dynamic Function(Map<String, dynamic>)? fromEncodable,
    ExpiryPolicy? expiryPolicy,
    KeySampler? sampler,
    EvictionPolicy? evictionPolicy,
    int? maxEntries,
    CacheLoader<T>? cacheLoader,
    Clock? clock,
    EventListenerMode? eventListenerMode,
    bool? statsEnabled,
    CacheStats? stats});