|
NASA World Wind | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectgov.nasa.worldwind.cache.BasicMemoryCache
public final class BasicMemoryCache
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from interface gov.nasa.worldwind.cache.MemoryCache |
|---|
MemoryCache.CacheListener |
| Constructor Summary | |
|---|---|
BasicMemoryCache(long loWater,
long capacity)
Constructs a new cache using capacity for maximum size, and loWater for the low water. |
|
| Method Summary | |
|---|---|
boolean |
add(Object key,
Cacheable clientObject)
Attempts to add the Cacheable object referenced by the key. |
boolean |
add(Object key,
Object clientObject,
long clientObjectSize)
Adds an object to the cache. |
void |
addCacheListener(MemoryCache.CacheListener listener)
Adds a cache listener, MemoryCache listeners are used to notify classes when an item is removed from the cache. |
void |
clear()
Empties the cache. |
boolean |
contains(Object key)
Returns true if the cache contains the item referenced by key. |
protected void |
finalize()
|
long |
getCapacity()
Retrieves the maximum size of the cache in bytes. |
long |
getFreeCapacity()
Retrieves the available space for storing new items. |
Set<Object> |
getKeySet()
Obtain a list of all the keys in the cache. |
long |
getLowWater()
Returns the low water level in bytes. |
String |
getName()
|
int |
getNumObjects()
Retrieve the number of items stored in the MemoryCache. |
Object |
getObject(Object key)
Obtain the object referenced by key without removing it. |
long |
getUsedCapacity()
Retrieves the amount of used MemoryCache space. |
void |
remove(Object key)
Remove the object reference by key from the cache. |
void |
removeCacheListener(MemoryCache.CacheListener listener)
Removes a cache listener, objects using this listener will no longer receive notification of cache events. |
void |
setCapacity(long newCapacity)
Sets the new capacity (in bytes) for the cache. |
void |
setLowWater(long loWater)
Sets the new low water level in bytes, which controls how aggresively the cache discards items. |
void |
setName(String name)
|
String |
toString()
a String representation of this object is returned. This representation consists of maximum
size, current used capacity and number of currently cached items. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public BasicMemoryCache(long loWater,
long capacity)
capacity for maximum size, and loWater for the low water.
loWater - the low water levelcapacity - the maximum capacity| Method Detail |
|---|
public boolean add(Object key,
Cacheable clientObject)
MemoryCacheCacheable object referenced by the key. No explicit size value is required as
this method queries the Cacheable to discover the size.
This method should be declared synchronized when it is implemented.
add in interface MemoryCacheCacheable
public boolean add(Object key,
Object clientObject,
long clientObjectSize)
add in interface MemoryCachekey - The unique reference key that identifies this object.clientObject - The actual object to be cached.clientObjectSize - The size of the object in bytes.
public void addCacheListener(MemoryCache.CacheListener listener)
addCacheListener in interface MemoryCachelistener - The new CacheListener
IllegalArgumentException - is listener is nullpublic void clear()
clear in interface MemoryCachepublic boolean contains(Object key)
getObject()
should be used for that purpose
contains in interface MemoryCachekey - The key of a specific object
IllegalArgumentException - if key is null
protected void finalize()
throws Throwable
finalize in class ObjectThrowablepublic long getCapacity()
MemoryCache
getCapacity in interface MemoryCachepublic long getFreeCapacity()
MemoryCache
getFreeCapacity in interface MemoryCachepublic Set<Object> getKeySet()
getKeySet in interface MemoryCacheSet of all keys in the cache.public long getLowWater()
getLowWater in interface MemoryCachepublic String getName()
getName in interface MemoryCachepublic int getNumObjects()
MemoryCacheMemoryCache.
getNumObjects in interface MemoryCachepublic Object getObject(Object key)
getObject in interface MemoryCachekey - The key for the object to be found.
IllegalArgumentException - if key is nullpublic long getUsedCapacity()
MemoryCacheMemoryCache space. The value returned is in bytes.
getUsedCapacity in interface MemoryCachepublic void remove(Object key)
remove in interface MemoryCachekey - the key of the object to be removed
IllegalArgumentException - if key is nullpublic void removeCacheListener(MemoryCache.CacheListener listener)
removeCacheListener in interface MemoryCachelistener - The CacheListener to remove
IllegalArgumentException - if listener is nullpublic void setCapacity(long newCapacity)
setCapacity in interface MemoryCachenewCapacity - the new capacity of the cache.public void setLowWater(long loWater)
setLowWater in interface MemoryCacheloWater - the new low water level in bytes.public void setName(String name)
setName in interface MemoryCachepublic String toString()
String representation of this object is returned. This representation consists of maximum
size, current used capacity and number of currently cached items.
toString in class ObjectString representation of this object
|
NASA World Wind | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||