com.aspc.remote.memory

Class CacheLongTable<V>

java.lang.Object

com.aspc.remote.memory.internal.CacheTableTemplate<V>

com.aspc.remote.memory.CacheLongTable<V>

Type Parameters:

V - the class.

All Implemented Interfaces:

MemoryHandler

Direct Known Subclasses:

ResetableCacheLongTable

public class CacheLongTable<V>
extends CacheTableTemplate<V>

Cache Table is used to hold data cache which may be cleared independently by of the Memory Manager. The data held by these cache tables will not by default release elements that are referenced.
THREAD MODE: MULTI-THREADED memory management

Since:

31 December 1998

Author:

Nigel Leck

Nested Class Summary

Nested classes/interfaces inherited from interface com.aspc.remote.memory.MemoryHandler

MemoryHandler.Cost

Field Summary

Fields inherited from class com.aspc.remote.memory.internal.CacheTableTemplate

cost, count, data, description, estEmptyCount, INITIAL_CAPACITY, memoryMangerThreshold, PROPERTY_ENABLE_POINTER_CHECK, rwLock, unallocated

Constructor Summary

Constructors

Constructor and Description
CacheLongTable(java.lang.String description) Creates a new Cache Long table.
CacheLongTable(java.lang.String description, MemoryHandler.Cost cost) Creates a new Cache Long table.

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(long key) Returns true if this map contains a mapping for the specified key.
protected InterfaceEntry[]	createArray(int size) create a new array
V	find(long key) find the key and throw NotFound if known.
V	get(long key) Retrieve the data for the key.
long[]	getKeyArray() creates a array of the keys.
boolean	isLocked(long key) Returns true if the entry is locked into memory
boolean	lock(long key)
protected CacheEntryLong	makeCacheEntryLong(long key, int hashCode, java.lang.Object referent, InterfaceEntry next) make a cache entry for objects with a long for a key.
V	place(long key, V orginal, boolean keepFoundObject) Returns the current object which is in this cache table.
V	placeIfAbsent(long key, V value) Returns the current object which is in this cache table.
V	put(long key, V orginal) Puts data into the cache table.
boolean	release(long key) Release the hard link to the object.
V	remove(long key) Removes the mapping for this key from this map if present.
boolean	unlock(long key)

Methods inherited from class com.aspc.remote.memory.internal.CacheTableTemplate

checkRegister, clear, compact, containsValue, freeMemory, getAverageSize, getCost, getDescription, getEstimatedSize, getHardLinkCount, getLastAccessed, isEmpty, panicFreeMemory, queuedFreeMemory, rehash, removeElement, setAverageSize, setMayReleaseReferences, setThreshold, size, stats, tidyUp, tidyUpRequired, toString, touch

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CacheLongTable

public CacheLongTable(@Nonnull
                      java.lang.String description)

Creates a new Cache Long table.

Parameters:

description - The description of this cache table.

CacheLongTable

public CacheLongTable(@Nonnull
                      java.lang.String description,
                      @Nonnull
                      MemoryHandler.Cost cost)

Creates a new Cache Long table.

Parameters:

description - The description of this cache table.

cost - The relative cost.

Method Detail

getKeyArray

@CheckReturnValue
 @Nonnull
public long[] getKeyArray()

creates a array of the keys.

Returns:

The array keys

containsKey

@CheckReturnValue
public boolean containsKey(long key)

Returns true if this map contains a mapping for the specified key.

Parameters:

key - key whose presence in this Map is to be tested.

Returns:

true if this map contains a mapping for the specified key.

isLocked

@CheckReturnValue
public boolean isLocked(long key)

Returns true if the entry is locked into memory

Parameters:

key - key whose presence in this Map is to be tested.

Returns:

true if locked.

lock

public boolean lock(long key)

Parameters:

key - the key to lock

Returns:

true if locked.

unlock

public boolean unlock(long key)

Parameters:

key - the key to unlock

Returns:

true if unlocked.

release

public boolean release(long key)

Release the hard link to the object. Returns true if this map contains a mapping for the specified key.

Parameters:

key - key whose presence in this Map is to be tested.

Returns:

true if this map contains a mapping for the specified key.

remove

@Nullable
public V remove(long key)

Removes the mapping for this key from this map if present.

Parameters:

key - key whose mapping is to be removed from the map.

Returns:

previous value associated with specified key, or null if there was no mapping for key. A null return can also indicate that the map previously associated null with the specified key.

get

@Nullable
 @CheckReturnValue
public V get(long key)

Retrieve the data for the key. Only check the weak table if it contains keys that are not in hard map table. We do this because weak references are slow on Solaris as of 2.8

Parameters:

key - The key

Returns:

The object if found

find

@Nullable
 @CheckReturnValue
public V find(long key)
                                    throws java.lang.Exception

find the key and throw NotFound if known.

Parameters:

key - the key

Returns:

The found object.

Throws:

java.lang.Exception - NotFoundException if the object is known not to exist.

put

@Nullable
public V put(long key,
                       @Nullable
                       V orginal)

Puts data into the cache table. Common data is replaced to save memory

Parameters:

orginal - The object to put into the cache table.

key - The key of this object

Returns:

the object that has been replaced.

makeCacheEntryLong

@CheckReturnValue
 @Nonnull
protected CacheEntryLong makeCacheEntryLong(long key,
                                                                        int hashCode,
                                                                        java.lang.Object referent,
                                                                        InterfaceEntry next)

make a cache entry for objects with a long for a key.

Parameters:

key - the key

hashCode - the hash number

referent - the object that we want to cache

next - the next entry

Returns:

the entry

placeIfAbsent

@Nonnull
public V placeIfAbsent(long key,
                                @Nonnull
                                V value)

Returns the current object which is in this cache table.

Parameters:

key - The key of the object to place

value - The object to place.

Returns:

The actual object stored.

place

@Nullable
public V place(long key,
                         @Nullable
                         V orginal,
                         boolean keepFoundObject)

Returns the current object which is in this cache table.

Parameters:

key - The key of the object to place

orginal - The object to place.

keepFoundObject - Should we keep the original object if found ( are they the same)

Returns:

The actual object stored.

createArray

@Nonnull
protected InterfaceEntry[] createArray(int size)

create a new array

Specified by:

createArray in class CacheTableTemplate<V>

Parameters:

size - the new size of the array

Returns:

the new array