Package org.redisson.spring.cache

Class CacheConfig

java.lang.Object
org.redisson.spring.cache.CacheConfig
public class CacheConfig extends Object
Cache config object used for Spring cache configuration.
Author:
Nikita Koksharov

  • Constructor Details

    • CacheConfig

      public CacheConfig()
      Creates config object with ttl = 0 and maxIdleTime = 0.

    • CacheConfig

      public CacheConfig(long ttl, long maxIdleTime)
      Creates config object.
      Parameters:
      ttl - - time to live for key\value entry in milliseconds. If 0 then time to live doesn't affect entry expiration.
      maxIdleTime - - max idle time for key\value entry in milliseconds.

      if maxIdleTime and ttl params are equal to 0 then entry stores infinitely.

  • Method Details

    • getTTL

      public long getTTL()

    • setTTL

      public void setTTL(long ttl)
      Set time to live for key\value entry in milliseconds.
      Parameters:
      ttl - - time to live for key\value entry in milliseconds. If 0 then time to live doesn't affect entry expiration.

    • getMaxSize

      public int getMaxSize()

    • setMaxSize

      public void setMaxSize(int maxSize)
      Set max size of map. Superfluous elements are evicted using LRU algorithm.
      Parameters:
      maxSize - - max size If 0 the cache is unbounded (default).

    • getEvictionMode

      public org.redisson.api.EvictionMode getEvictionMode()

    • setEvictionMode

      public CacheConfig setEvictionMode(org.redisson.api.EvictionMode evictionMode)
      Set the eviction mode of the map. Superfluous elements are evicted using LRU or LFU algorithm.
      Parameters:
      evictionMode - - eviction mode (LRU, LFU)
      Returns:

    • getMaxIdleTime

      public long getMaxIdleTime()

    • setMaxIdleTime

      public void setMaxIdleTime(long maxIdleTime)
      Set max idle time for key\value entry in milliseconds.
      Parameters:
      maxIdleTime - - max idle time for key\value entry in milliseconds. If 0 then max idle time doesn't affect entry expiration.

    • addListener

      public void addListener(org.redisson.api.map.event.MapEntryListener listener)
      listener will invoke if one of the ttl,maxIdleTime,maxSize is set listener Is one of the following implementations: EntryCreatedListener EntryExpiredListener EntryRemovedListener EntryUpdatedListener
      Parameters:
      listener - listener

    • setListeners

      public void setListeners(List<org.redisson.api.map.event.MapEntryListener> listeners)

    • getListeners

      public List<org.redisson.api.map.event.MapEntryListener> getListeners()

    • fromYAML

      public static Map<String,? extends CacheConfig> fromYAML(String content) throws IOException
      Read config objects stored in YAML format from String
      Parameters:
      content - of config
      Returns:
      config
      Throws:
      IOException - error

    • fromYAML

      public static Map<String,? extends CacheConfig> fromYAML(InputStream inputStream) throws IOException
      Read config objects stored in YAML format from InputStream
      Parameters:
      inputStream - of config
      Returns:
      config
      Throws:
      IOException - error

    • fromYAML

      public static Map<String,? extends CacheConfig> fromYAML(File file) throws IOException
      Read config objects stored in YAML format from File
      Parameters:
      file - of config
      Returns:
      config
      Throws:
      IOException - error

    • fromYAML

      public static Map<String,? extends CacheConfig> fromYAML(URL url) throws IOException
      Read config objects stored in YAML format from URL
      Parameters:
      url - of config
      Returns:
      config
      Throws:
      IOException - error

    • fromYAML

      public static Map<String,? extends CacheConfig> fromYAML(Reader reader) throws IOException
      Read config objects stored in YAML format from Reader
      Parameters:
      reader - of config
      Returns:
      config
      Throws:
      IOException - error

    • toYAML

      public static String toYAML(Map<String,? extends CacheConfig> config) throws IOException
      Convert current configuration to YAML format
      Parameters:
      config - map
      Returns:
      yaml string
      Throws:
      IOException - error

    • toString

      public String toString()
      Overrides:
      toString in class Object