Class ConverterCollections.ConverterCacheEnumerator

A Converter CacheEnumerator views an underlying ICacheEnumerator through key and value IConverters.

Inheritance

object

ConverterCollections.ConverterCacheEnumerator

Implements

ICacheEnumerator

IDictionaryEnumerator

IEnumerator

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Tangosol.Util

Assembly: Coherence.dll

Syntax

public class ConverterCollections.ConverterCacheEnumerator : ICacheEnumerator, IDictionaryEnumerator, IEnumerator

Constructors

ConverterCacheEnumerator(ICacheEnumerator, IConverter, IConverter, IConverter)

Constructor.

Declaration

public ConverterCacheEnumerator(ICacheEnumerator enumerator, IConverter convKeyUp, IConverter convValueUp, IConverter convValueDown)

Parameters

Type	Name	Description
ICacheEnumerator	enumerator	The underlying ICacheEnumerator.
IConverter	convKeyUp	The IConverter used to view keys of entries being enumerated.
IConverter	convValueUp	The IConverter used to view values of entries being enumerated.
IConverter	convValueDown	The IConverter used to change values of entries being enumerated.

Fields

m_cacheEnum

The underlying ICacheEnumerator.

Declaration

protected ICacheEnumerator m_cacheEnum

Field Value

Type	Description
ICacheEnumerator

m_convKeyUp

The IConverter used to view keys of entries being enumerated.

Declaration

protected IConverter m_convKeyUp

Field Value

Type	Description
IConverter

m_convValDown

The IConverter used to change values of entries being enumerated.

Declaration

protected IConverter m_convValDown

Field Value

Type	Description
IConverter

m_convValueUp

The IConverter used to view values of entries being enumerated.

Declaration

protected IConverter m_convValueUp

Field Value

Type	Description
IConverter

Properties

CacheEnumerator

The underlying ICacheEnumerator.

Declaration

public virtual ICacheEnumerator CacheEnumerator { get; }

Property Value

Type	Description
ICacheEnumerator	The underlying ICacheEnumerator.

ConverterKeyUp

The IConverter used to convert keys of the ICacheEntry objects which underlying enumerator iterates.

Declaration

public virtual IConverter ConverterKeyUp { get; }

Property Value

Type	Description
IConverter	The IConverter used to convert keys of the ICacheEntry objects which underlying enumerator iterates.

ConverterValueDown

The IConverter used to pass values down to the ICacheEntry objects of the underlying enumerator.

Declaration

public virtual IConverter ConverterValueDown { get; }

Property Value

Type	Description
IConverter	The IConverter used to pass values down to the ICacheEntry objects of the underlying enumerator.

ConverterValueUp

The IConverter used to convert values of the ICacheEntry objects which underlying enumerator iterates.

Declaration

public virtual IConverter ConverterValueUp { get; }

Property Value

Type	Description
IConverter	The IConverter used to convert values of the ICacheEntry objects which underlying enumerator iterates.

Current

Gets the current element in the collection.

Declaration

public virtual object Current { get; }

Property Value

Type	Description
object	The current element in the collection.

Exceptions

Type	Condition
InvalidOperationException	The enumerator is positioned before the first element of the collection or after the last element.

Entry

Gets both the key and the value of the current cache entry.

Declaration

public virtual ICacheEntry Entry { get; }

Property Value

Type	Description
ICacheEntry	An ICacheEntry containing both the key and the value of the current cache entry.

Key

Gets the key of the current cache entry.

Declaration

public virtual object Key { get; }

Property Value

Type	Description
object	The key of the current element of the enumeration.

Exceptions

Type	Condition
InvalidOperationException	The enumerator is positioned before the first entry of the cache or after the last entry.

Value

Gets the value of the current cache entry.

Declaration

public virtual object Value { get; }

Property Value

Type	Description
object	The value of the current element of the enumeration.

Exceptions

Type	Condition
InvalidOperationException	The enumerator is positioned before the first entry of the cache or after the last entry.

Methods

InstantiateEntry(ICacheEntry, IConverter, IConverter, IConverter)

Returns an instance of a ICacheEntry that uses IConverters to retrieve the entry's data.

Declaration

protected virtual ICacheEntry InstantiateEntry(ICacheEntry entry, IConverter convKeyUp, IConverter convValUp, IConverter convValDown)

Parameters

Type	Name	Description
ICacheEntry	entry	The underlying ICacheEntry.
IConverter	convKeyUp	The IConverter to view the underlying entry's key.
IConverter	convValUp	The IConverter to view the underlying entry's value.
IConverter	convValDown	The IConverter to change the underlying entry's value.

Returns

Type	Description
ICacheEntry	An ICacheEntry instance.

MoveNext()

Advances the enumerator to the next element of the collection.

Declaration

public virtual bool MoveNext()

Returns

Type	Description
bool	true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

Exceptions

Type	Condition
InvalidOperationException	The collection was modified after the enumerator was created.

Reset()

Sets the enumerator to its initial position, which is before the first element in the collection.

Declaration

public virtual void Reset()

Exceptions

Type	Condition
InvalidOperationException	The collection was modified after the enumerator was created.

Implements

ICacheEnumerator

IDictionaryEnumerator

IEnumerator