View Javadoc

1   package com.atlassian.vcache.internal;
2   
3   import javax.annotation.Nonnull;
4   
5   import com.atlassian.vcache.ExternalCache;
6   import com.atlassian.vcache.ExternalCacheSettings;
7   import com.atlassian.vcache.JvmCache;
8   import com.atlassian.vcache.JvmCacheSettings;
9   
10  /**
11   * A manager for retrieving the default settings for caches.
12   *
13   * @since 1.0
14   */
15  public interface VCacheSettingsDefaultsProvider
16  {
17      /**
18       * Obtain the default settings for an {@link ExternalCache}.
19       * @param name the cache name
20       * @return the default settings for the specified cache
21       */
22      @Nonnull
23      ExternalCacheSettings getExternalDefaults(String name);
24  
25      /**
26       * Obtain the default settings for a {@link JvmCache}.
27       * @param name the cache name
28       * @return the default settings for the specified cache
29       */
30      @Nonnull
31      JvmCacheSettings getJvmDefaults(String name);
32  }