com.j_spaces.core.cache

Class TemplateCacheInfo

java.lang.Object

com.j_spaces.core.cache.TemplateCacheInfo

All Implemented Interfaces:

IHashEntry<Object,IStoredList<TemplateCacheInfo>>, ILeasedEntryCacheInfo, ICollection<TemplateCacheInfo>, IObjectInfo<TemplateCacheInfo>, IStoredList<TemplateCacheInfo>, IStoredListIterator<TemplateCacheInfo>, IObjectsList

public class TemplateCacheInfo
extends Object
implements ILeasedEntryCacheInfo, IStoredList<TemplateCacheInfo>, IStoredListIterator<TemplateCacheInfo>, IObjectInfo<TemplateCacheInfo>

Field Summary

Fields

Modifier and Type	Field and Description
ArrayList<IObjectInfo<TemplateCacheInfo>>	m_BackRefs
ITemplateHolder	m_TemplateHolder

Constructor Summary

Constructors

Constructor and Description
TemplateCacheInfo(ITemplateHolder templateHolder)

Method Summary

Modifier and Type	Method and Description
IObjectInfo<TemplateCacheInfo>	add(TemplateCacheInfo subject) Store an element in the list.
IObjectInfo<TemplateCacheInfo>	addUnlocked(TemplateCacheInfo subject) Store an element in the list, while the SL is unlocked .
boolean	contains(TemplateCacheInfo obj) Checks whether it contains the specified element.
void	dump(Logger logger, String msg) Dump list content, used for Debug.
IStoredListIterator<TemplateCacheInfo>	establishListScan(boolean random_scan) establish a scan position.
void	freeSLHolder(IStoredListIterator slh) Called by an outside scan that wants to quit the scan and return the slholder to the resource pool.
int	getHashCode(int id)
IObjectInfo<TemplateCacheInfo>	getHead() Returns the first element in the list (fifo)
int	getIndexPos()
Object	getKey(int id)
int	getLatestIndexCreationNumber()
IStoredList<Object>	getLeaseManagerListRef()
IObjectInfo<Object>	getLeaseManagerPosition()
TemplateCacheInfo	getObjectFromHead() Returns the value of the first element in the list (fifo)
Object	getObjectStoredInLeaseManager()
TemplateCacheInfo	getSubject() Gets the subject pointed to by the cursor's scan.
IStoredList<TemplateCacheInfo>	getValue(int id)
boolean	hasNext()
void	initBackRefs(int numOfIndexes)
boolean	invalidate() Sets an indication that this StoredList is invalid.
boolean	isConnectedToLeaseManager()
boolean	isEmpty() Returns true if this list is empty, i.e.
boolean	isIterator() is the list an iterator or basic list ?
boolean	isMultiObjectCollection() is it an actual multi object container.
boolean	isMultiValueIterator()
boolean	isNativeHashEntry()
boolean	isOffHeapEntry()
boolean	isSameLeaseManagerRef(ILeasedEntryCacheInfo other)
TemplateCacheInfo	next()
IStoredListIterator<TemplateCacheInfo>	next(IStoredListIterator<TemplateCacheInfo> slh) Returns the next element in the scan order.
boolean	optimizeScanForSingleObject() return true if we can save iterator creation and get a single entry
void	release() Release of this SLHolder resource
void	releaseScan()
void	remove()
void	remove(IObjectInfo oi) Remove an element described by ObjectInfo.
boolean	removeByObject(TemplateCacheInfo obj) Given an element scan the list, find it and remove it.
void	removeUnlocked(IObjectInfo oi) Remove an element described by ObjectInfo, while the SL is unlocked.
void	setLatestIndexCreationNumber(int val)
void	setLeaseManagerListRefAndPosition(IStoredList<Object> entriesList, IObjectInfo<Object> entryPos)
void	setSubject(TemplateCacheInfo subject) Sets the subject pointed to by the cursor's scan.
int	size() Returns the amount of elements in the StoredList.

Methods inherited from class java.lang.Object

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

Field Detail

m_BackRefs

public ArrayList<IObjectInfo<TemplateCacheInfo>> m_BackRefs

m_TemplateHolder

public final ITemplateHolder m_TemplateHolder

Constructor Detail

TemplateCacheInfo

public TemplateCacheInfo(ITemplateHolder templateHolder)

Method Detail

initBackRefs

public void initBackRefs(int numOfIndexes)

setLeaseManagerListRefAndPosition

public void setLeaseManagerListRefAndPosition(IStoredList<Object> entriesList,
                                              IObjectInfo<Object> entryPos)

Specified by:

setLeaseManagerListRefAndPosition in interface ILeasedEntryCacheInfo

getLeaseManagerListRef

public IStoredList<Object> getLeaseManagerListRef()

Specified by:

getLeaseManagerListRef in interface ILeasedEntryCacheInfo

getLeaseManagerPosition

public IObjectInfo<Object> getLeaseManagerPosition()

Specified by:

getLeaseManagerPosition in interface ILeasedEntryCacheInfo

isConnectedToLeaseManager

public boolean isConnectedToLeaseManager()

Specified by:

isConnectedToLeaseManager in interface ILeasedEntryCacheInfo

isSameLeaseManagerRef

public boolean isSameLeaseManagerRef(ILeasedEntryCacheInfo other)

Specified by:

isSameLeaseManagerRef in interface ILeasedEntryCacheInfo

isOffHeapEntry

public boolean isOffHeapEntry()

Specified by:

isOffHeapEntry in interface ILeasedEntryCacheInfo

getObjectStoredInLeaseManager

public Object getObjectStoredInLeaseManager()

Specified by:

getObjectStoredInLeaseManager in interface ILeasedEntryCacheInfo

getLatestIndexCreationNumber

public int getLatestIndexCreationNumber()

setLatestIndexCreationNumber

public void setLatestIndexCreationNumber(int val)

getHead

public IObjectInfo<TemplateCacheInfo> getHead()

Description copied from interface: IStoredList

Returns the first element in the list (fifo)

Specified by:

getHead in interface IStoredList<TemplateCacheInfo>

Returns:

the head of the list

getObjectFromHead

public TemplateCacheInfo getObjectFromHead()

Description copied from interface: IStoredList

Returns the value of the first element in the list (fifo)

Specified by:

getObjectFromHead in interface IStoredList<TemplateCacheInfo>

Returns:

the value of the head of the list

freeSLHolder

public void freeSLHolder(IStoredListIterator slh)

Description copied from interface: IStoredList

Called by an outside scan that wants to quit the scan and return the slholder to the resource pool.

Specified by:

freeSLHolder in interface IStoredList<TemplateCacheInfo>

Parameters:

slh - Holder resource to return to pool; can be null.

remove

public void remove(IObjectInfo oi)

Description copied from interface: IStoredList

Remove an element described by ObjectInfo. [Tail] - .. - [beforeOi] - [oi] - [afterOi] - .. - [Head]

Specified by:

remove in interface IStoredList<TemplateCacheInfo>

Parameters:

oi - an existing element between Tail and Head

removeUnlocked

public void removeUnlocked(IObjectInfo oi)

Description copied from interface: IStoredList

Remove an element described by ObjectInfo, while the SL is unlocked. [Tail] - .. - [beforeOi] - [oi] - [afterOi] - .. - [Head]

Specified by:

removeUnlocked in interface IStoredList<TemplateCacheInfo>

Parameters:

oi - an existing element between Tail and Head

invalidate

public boolean invalidate()

Description copied from interface: IStoredList

Sets an indication that this StoredList is invalid. if isEmpty() returns true, the indication is set; otherwise the indication remains false. Called by PersistentGC when scanning for empty StoredList that can be garbage collected.

Specified by:

invalidate in interface IStoredList<TemplateCacheInfo>

Returns:

true if StoredList was set to invalid; false otherwise.

dump

public void dump(Logger logger,
                 String msg)

Description copied from interface: IStoredList

Dump list content, used for Debug.

Specified by:

dump in interface IStoredList<TemplateCacheInfo>

Parameters:

logger - logger to use

msg - message to add in log

size

public int size()

Description copied from interface: ICollection

Returns the amount of elements in the StoredList.

Specified by:

size in interface ICollection<TemplateCacheInfo>

Returns:

size of the StoredList

See Also:

ICollection.isEmpty()

isEmpty

public boolean isEmpty()

Description copied from interface: ICollection

Returns true if this list is empty, i.e. has no elements. [Tail] - [Head]

Specified by:

isEmpty in interface ICollection<TemplateCacheInfo>

Returns:

true if list is empty; false otherwise.

establishListScan

public IStoredListIterator<TemplateCacheInfo> establishListScan(boolean random_scan)

Description copied from interface: ICollection

establish a scan position. if random scan is supported we select a random position; otherwise we return the first resource by scanning from head to tail.

Specified by:

establishListScan in interface ICollection<TemplateCacheInfo>

Parameters:

random_scan - true enable random scan; false start from head.

Returns:

a Holder for this scan. This Resource should be released if scan ended prematurely.

next

public IStoredListIterator<TemplateCacheInfo> next(IStoredListIterator<TemplateCacheInfo> slh)

Description copied from interface: ICollection

Returns the next element in the scan order. Calling this method until it returns null, will return each element as part of the SLHolders subject.

Specified by:

next in interface ICollection<TemplateCacheInfo>

Parameters:

slh - Holder representing a pivot position.

Returns:

the next pivot position in this scan; null if reached end of scan.

add

public IObjectInfo<TemplateCacheInfo> add(TemplateCacheInfo subject)

Description copied from interface: ICollection

Store an element in the list. New elements are inserted at the tail.

Specified by:

add in interface ICollection<TemplateCacheInfo>

Parameters:

subject - element to store.

Returns:

an information node representing the inserted element; null if StoredList has been invalidated.

addUnlocked

public IObjectInfo<TemplateCacheInfo> addUnlocked(TemplateCacheInfo subject)

Description copied from interface: IStoredList

Store an element in the list, while the SL is unlocked . New elements are inserted at the tail.

Specified by:

addUnlocked in interface IStoredList<TemplateCacheInfo>

Parameters:

subject - element to store.

Returns:

an information node representing the inserted element; null if StoredList has been invalidated.

removeByObject

public boolean removeByObject(TemplateCacheInfo obj)

Description copied from interface: ICollection

Given an element scan the list, find it and remove it.

Specified by:

removeByObject in interface ICollection<TemplateCacheInfo>

Parameters:

obj - element to remove

Returns:

true if object was removed; false otherwise (if element wasn't found)

contains

public boolean contains(TemplateCacheInfo obj)

Description copied from interface: ICollection

Checks whether it contains the specified element.

Specified by:

contains in interface ICollection<TemplateCacheInfo>

Parameters:

obj - the element to search for

Returns:

true if element exists in the StoredList; false otherwise.

setSubject

public void setSubject(TemplateCacheInfo subject)

Description copied from interface: IStoredListIterator

Sets the subject pointed to by the cursor's scan.

Specified by:

setSubject in interface IObjectInfo<TemplateCacheInfo>

Specified by:

setSubject in interface IStoredListIterator<TemplateCacheInfo>

Parameters:

subject - The subject to set.

getSubject

public TemplateCacheInfo getSubject()

Description copied from interface: IStoredListIterator

Gets the subject pointed to by the cursor's scan.

Specified by:

getSubject in interface IObjectInfo<TemplateCacheInfo>

Specified by:

getSubject in interface IStoredListIterator<TemplateCacheInfo>

Returns:

Returns the subject.

isMultiObjectCollection

public boolean isMultiObjectCollection()

Description copied from interface: ICollection

is it an actual multi object container.

Specified by:

isMultiObjectCollection in interface ICollection<TemplateCacheInfo>

Returns:

true if its an actual list; false otherwise

optimizeScanForSingleObject

public boolean optimizeScanForSingleObject()

return true if we can save iterator creation and get a single entry

Specified by:

optimizeScanForSingleObject in interface IStoredList<TemplateCacheInfo>

Returns:

true if we can optimize

getHashCode

public int getHashCode(int id)

Specified by:

getHashCode in interface IHashEntry<Object,IStoredList<TemplateCacheInfo>>

getKey

public Object getKey(int id)

Specified by:

getKey in interface IHashEntry<Object,IStoredList<TemplateCacheInfo>>

getValue

public IStoredList<TemplateCacheInfo> getValue(int id)

Specified by:

getValue in interface IHashEntry<Object,IStoredList<TemplateCacheInfo>>

isNativeHashEntry

public boolean isNativeHashEntry()

Specified by:

isNativeHashEntry in interface IHashEntry<Object,IStoredList<TemplateCacheInfo>>

Returns:

true if this is a native hashmap entry

release

public void release()

Description copied from interface: IStoredListIterator

Release of this SLHolder resource

Specified by:

release in interface IStoredListIterator<TemplateCacheInfo>

See Also:

Resource.release()

isMultiValueIterator

public boolean isMultiValueIterator()

releaseScan

public void releaseScan()

getIndexPos

public int getIndexPos()

hasNext

public boolean hasNext()

next

public TemplateCacheInfo next()

remove

public void remove()

isIterator

public boolean isIterator()

Description copied from interface: IObjectsList

is the list an iterator or basic list ?

Specified by:

isIterator in interface IObjectsList