gov/nasa/worldwind/cache/Cacheable.java

   1 package gov.nasa.worldwind.cache;
   2 /*
   3 Copyright (C) 2001, 2006 United States Government
   4 as represented by the Administrator of the
   5 National Aeronautics and Space Administration.
   6 All Rights Reserved.
   7 */
   8
   9 /**
  10  * @author Tom Gaskins
  11  * @version $Id: Cacheable.java 2422 2007-07-25 23:07:49Z tgaskins $
  12  */
  13 public interface Cacheable
  14 {
  15     // TODO: search for size queries that do not used this interface and change them to do so.
  16     // currently (22 Nov 2006), only  BasicElevationModel.addTileToCache(Tile, ShortBuffer) does not use Cacheable
  17
  18     /**
  19      * Retrieves the approximate size of this object in bytes. Implementors are encouraged to calculate the exact size
  20      * for smaller objects, but use approximate values for objects that include such large components that the
  21      * approximation would produce an error so small that the extra computation would be wasteful.
  22      *
  23      * @return this <code>Cacheable</code> object's size in bytes
  24      */
  25     long getSizeInBytes();
  26 }