Interface ConfigurableCacheMap.UnitCalculator

All Known Implementing Classes:
BinaryMemoryCalculator, LocalCache.InternalUnitCalculator, SimpleMapIndex.IndexCalculator, SimpleMemoryCalculator
Enclosing interface:
ConfigurableCacheMap

public static interface ConfigurableCacheMap.UnitCalculator
A unit calculator is an object that can calculate the cost of caching an object.
  • Method Summary

    Modifier and Type
    Method
    Description
    int
    calculateUnits(Object oKey, Object oValue)
    Calculate a cache cost for the specified cache entry key and value.
    Obtain the name of the unit calculator.
  • Method Details

    • calculateUnits

      int calculateUnits(Object oKey, Object oValue)
      Calculate a cache cost for the specified cache entry key and value.
      Parameters:
      oKey - the cache key to evaluate for unit cost
      oValue - the cache value to evaluate for unit cost
      Returns:
      an integer value 0 or greater, with a larger value signifying a higher cost
      Throws:
      IllegalArgumentException - if any of the specified object types cannot be processed by this calculator
    • getName

      String getName()
      Obtain the name of the unit calculator. This is intended to be human readable for use in a monitoring tool; examples include "SimpleMemoryCalculator" and "BinaryMemoryCalculator".
      Returns:
      the name of the unit calculator