coldbox.system.cache.policies

Class AbstractEvictionPolicy

railo-context.Component
        extended by coldbox.system.cache.policies.AbstractEvictionPolicy
Class Attributes:
  • output : false
    •  
  • synchronized : false
    •  
  • accessors : false
    •  
  • persistent : false
    •  
  • serializable : false
    •  
  • colddoc:abstract : true
    •  
    All Implemented Interfaces:
    IEvictionPolicy
    Direct Known Subclasses:
    FIFO , LFU , LIFO , LRU

    An abstract CacheBox eviction policy

    Constructor Summary
    init(any<ICacheProvider> cacheProvider)
          Constructor.
    Method Summary
    void execute()
         Execute the eviction policy on the associated cache.
    any<ICacheProvider> getAssociatedCache()
         Get the Associated Cache Provider of type: coldbox.
    private any getLogger()
         Get a logbox logger for the policy.
    private any getUtil()
         Create and return a ColdBox utility object.
    private void processEvictions(any index)
         Abstract processing of evictions.
     
    Methods inherited from class railo-context.Component
    None
    Constructor Detail

    init

    public init(any<ICacheProvider> cacheProvider)

    Constructor

    Parameters:
    cacheProvider - The associated cache provider of type: coldbox.system.cache.ICacheProvider
    Method Detail

    execute

    public void execute()

    Execute the eviction policy on the associated cache

    Specified by:
    execute in interface IEvictionPolicy

    getAssociatedCache

    public any<ICacheProvider> getAssociatedCache()

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

    Specified by:
    getAssociatedCache in interface IEvictionPolicy

    getLogger

    private any getLogger()

    Get a logbox logger for the policy

    getUtil

    private any getUtil()

    Create and return a ColdBox utility object

    processEvictions

    private void processEvictions(any index)

    Abstract processing of evictions

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