cachebox.system.cache.policies

Abstract Class AbstractEvictionPolicy

lucee.Component
    extended by cachebox.system.cache.policies.AbstractEvictionPolicy
All Implemented Interfaces:
IEvictionPolicy
Direct Known Subclasses:
FIFO , LFU , LIFO , LRU

Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com ---- This is an AbstractEviction Policy object for usage in a CacheBox provider

Class Attributes:
  • doc_abstract : true
    •  
  • synchronized : false
    •  
  • accessors : true
    •  
  • persistent : false
    •  
  • serializable : false
    •  
    Property Summary
    type property default serializable required
    any cacheProvider
          Associated cache provider.

    • access = public
    • returntype = any
    		 true false
    any logger
          A logbox logger.

    • access = public
    • returntype = any
    		 true false
    Constructor Summary
    init(any<ICacheProvider> cacheProvider)
          Constructor.
    Method Summary
    void execute()
         Execute the eviction policy on the associated cache.
    any getAssociatedCache()
         Get the Associated Cache Provider of type: cachebox.
    string getCacheProvider()
    string getLogger()
    private any getUtil()
         Get utiliy object.
    private any processEvictions(any index)
         Abstract processing of evictions.
    any setCacheProvider(any cacheProvider)
    any setLogger(any logger)
     
    Methods inherited from class lucee.Component
    None
    Constructor Detail

    init

    public init(any<ICacheProvider> cacheProvider)

    Constructor

    Parameters:
    cacheProvider - The associated cache provider
    Property Detail

    cacheProvider

    property any cacheProvider

    Associated cache provider

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    logger

    property any logger

    A logbox logger

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true
    Method Detail

    execute

    public void execute()

    Execute the eviction policy on the associated cache

    Specified by:
    execute in interface IEvictionPolicy

    getAssociatedCache

    public any getAssociatedCache()

    Get the Associated Cache Provider of type: cachebox.system.cache.ICacheProvider

    Specified by:
    getAssociatedCache in interface IEvictionPolicy
    Returns:
    cachebox.system.cache.ICacheProvider

    getCacheProvider

    public string getCacheProvider()

    getLogger

    public string getLogger()

    getUtil

    private any getUtil()

    Get utiliy object

    Returns:
    cachebox.system.core.util.Util

    processEvictions

    private any processEvictions(any index)

    Abstract processing of evictions

    Parameters:
    index - The array of metadata keys used for processing evictions

    setCacheProvider

    public any setCacheProvider(any cacheProvider)

    Parameters:
    cacheProvider

    setLogger

    public any setLogger(any logger)

    Parameters:
    logger