com.j_spaces.kernel

Interface IStoredList<T>

All Superinterfaces:

ICollection<T>, IHashEntry<Object,IStoredList<T>>, IObjectsList

All Known Subinterfaces:

IEntryCacheInfo, IOrderedList<T>

All Known Implementing Classes:

AbstractStoredList, BlobStoreRefEntryCacheInfo, ConcurrentSegmentedStoredList, ConcurrentSegmentedStoredListHashmapEntry, ConcurrentStoredList, EvictableEntryCacheInfo, ExternallyLockedStoredList, HashedSimpleLockIStoredList, MemoryBasedEntryCacheInfo, RwlSegmentedStoredList, SimpleLockStoredList, TemplateCacheInfo

public interface IStoredList<T>
extends ICollection<T>, IHashEntry<Object,IStoredList<T>>, IObjectsList

Method Summary

Modifier and Type	Method and Description
IObjectInfo<T>	addUnlocked(T subject) Store an element in the list, while the SL is unlocked .
void	dump(Logger logger, String msg) Dump list content, used for Debug.
void	freeSLHolder(IStoredListIterator<T> slh) Called by an outside scan that wants to quit the scan and return the slholder to the resource pool.
IObjectInfo<T>	getHead() Returns the first element in the list (fifo)
T	getObjectFromHead() Returns the value of the first element in the list (fifo)
boolean	invalidate() Sets an indication that this StoredList is invalid.
boolean	optimizeScanForSingleObject() return true if we can save iterator creation and get a single entry
void	remove(IObjectInfo<T> oi) Remove an element described by ObjectInfo.
void	removeUnlocked(IObjectInfo<T> oi) Remove an element described by ObjectInfo, while the SL is unlocked.

Methods inherited from interface com.j_spaces.kernel.ICollection

add, contains, establishListScan, isEmpty, isMultiObjectCollection, next, removeByObject, size

Methods inherited from interface com.gigaspaces.internal.utils.collections.economy.IHashEntry

getHashCode, getKey, getValue, isNativeHashEntry

Methods inherited from interface com.j_spaces.kernel.list.IObjectsList

isIterator

Method Detail

getHead

IObjectInfo<T> getHead()

Returns the first element in the list (fifo)

Returns:

the head of the list

getObjectFromHead

T getObjectFromHead()

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

Returns:

the value of the head of the list

optimizeScanForSingleObject

boolean optimizeScanForSingleObject()

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

Returns:

true if we can optimize

freeSLHolder

void freeSLHolder(IStoredListIterator<T> slh)

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

Parameters:

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

remove

void remove(IObjectInfo<T> oi)

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

Parameters:

oi - an existing element between Tail and Head

removeUnlocked

void removeUnlocked(IObjectInfo<T> oi)

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

Parameters:

oi - an existing element between Tail and Head

addUnlocked

IObjectInfo<T> addUnlocked(T subject)

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

Parameters:

subject - element to store.

Returns:

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

invalidate

boolean invalidate()

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.

Returns:

true if StoredList was set to invalid; false otherwise.

dump

void dump(Logger logger,
          String msg)

Dump list content, used for Debug.

Parameters:

logger - logger to use

msg - message to add in log