Class ConverterCollections

A collection of ICollection implementation classes that use the IConverter interface to convert the items stored in underlying collection objects.

Inheritance

object

ConverterCollections

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 abstract class ConverterCollections

Methods

ConvertArray(object[], IConverter)

Convert the contents of the passed array.

Declaration

public static object[] ConvertArray(object[] ao, IConverter conv)

Parameters

Type	Name	Description
object[]	ao	An array of objects to convert.
IConverter	conv	The IConverter to use to convert the objects.

Returns

Type	Description
object[]	The passed array.

Remarks

The conversion is done "in place" in the passed array.

This helper method is intended to support the functionality of CopyTo(Array, int).

ConvertArray(object[], IConverter, object[])

Convert the contents of the passed source array into an array with the element type of the passed destination array, using the destination array itself if it is large enough, and placing a null in the first unused element of the destination array if it is larger than the source array.

Declaration

public static object[] ConvertArray(object[] aoSrc, IConverter conv, object[] aoDest)

Parameters

Type	Name	Description
object[]	aoSrc	An array of objects to convert.
IConverter	conv	The IConverter to use to convert the objects.
object[]	aoDest	The array to use to place the converted objects in if large enough, otherwise the array from which to obtain the element type to create a new array that is large enough.

Returns

Type	Description
object[]	An array whose component type is the same as the passed destination array and whose contents are the converted objects.

Remarks

This helper method is intended to support the functionality of CopyTo(Array, int).

GetCache(ICache, IConverter, IConverter, IConverter, IConverter)

Returns a Converter instance of ICache.

Declaration

public static ConverterCollections.ConverterCache GetCache(ICache cache, IConverter convKeyUp, IConverter convKeyDown, IConverter convValUp, IConverter convValDown)

Parameters

Type	Name	Description
ICache	cache	The underlying ICache.
IConverter	convKeyUp	The IConverter to view the underlying cache's keys through.
IConverter	convKeyDown	The IConverter to use to pass keys down to the underlying cache.
IConverter	convValUp	The IConverter to view the underlying cache's values through.
IConverter	convValDown	The IConverter to use to pass values down to the underlying cache.

Returns

Type	Description
ConverterCollections.ConverterCache	An ICache that views the keys and values of the passed ICache through the specified IConverters.

GetCacheEntries(ICollection, IConverter, IConverter, IConverter, IConverter)

Returns a Converter instance of a collection that holds ICacheEntry objects for a ConverterCollections.ConverterCache.

Declaration

public static ConverterCollections.ConverterCacheEntries GetCacheEntries(ICollection col, IConverter convKeyUp, IConverter convKeyDown, IConverter convValUp, IConverter convValDown)

Parameters

Type	Name	Description
ICollection	col	The underlying collection of ICacheEntry objects.
IConverter	convKeyUp	The IConverter to view the underlying entries' keys through.
IConverter	convKeyDown	The IConverter to pass keys down to the underlying entries collection.
IConverter	convValUp	The IConverter to view the underlying entries' values through.
IConverter	convValDown	The IConverter to pass values down to the underlying entries collection.

Returns

Type	Description
ConverterCollections.ConverterCacheEntries	A Converter collection that views the keys and values of the underlying collection's ICacheEntry objects through the specified key and value IConverters.

GetCacheEntry(ICacheEntry, IConverter, IConverter, IConverter)

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

Declaration

public static ConverterCollections.ConverterCacheEntry GetCacheEntry(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
ConverterCollections.ConverterCacheEntry	A ConverterCollections.ConverterCacheEntry that converts the passed entry data using the specified IConverters.

GetCacheEnumerator(ICacheEnumerator, IConverter, IConverter, IConverter)

Returns an instance of ICacheEnumerator that uses IConverters to view an underlying enumerator.

Declaration

public static ICacheEnumerator GetCacheEnumerator(ICacheEnumerator enumerator, IConverter convKeyUp, IConverter convValUp, IConverter convValDown)

Parameters

Type	Name	Description
ICacheEnumerator	enumerator	The underlying ICacheEnumerator.
IConverter	convKeyUp	The IConverter to view the underlying ICacheEnumerator keys through.
IConverter	convValUp	The IConverter to view the underlying ICacheEnumerator values through.
IConverter	convValDown	The IConverter to change the underlying ICacheEnumerator values through.

Returns

Type	Description
ICacheEnumerator	An ICacheEnumerator that views the passed enumerator through the specified IConverters.

GetCacheEventArgs(IObservableCache, CacheEventArgs, IConverter, IConverter)

Returns an instance of a CacheEventArgs that uses IConverters to retrieve the event data.

Declaration

public static CacheEventArgs GetCacheEventArgs(IObservableCache cache, CacheEventArgs evt, IConverter convKey, IConverter convVal)

Parameters

Type	Name	Description
IObservableCache	cache	The new event's source.
CacheEventArgs	evt	The underlying CacheEventArgs.
IConverter	convKey	The IConverter to view the underlying CacheEventArgs' key.
IConverter	convVal	The IConverter to view the underlying CacheEventArgs' values.

Returns

Type	Description
CacheEventArgs	A CacheEventArgs that converts the passed event data using the specified IConverters.

GetCollection(ICollection, IConverter, IConverter)

Returns an instance of ICollection that uses an IConverter to view an underlying collection.

Declaration

public static ConverterCollections.ConverterCollection GetCollection(ICollection col, IConverter convUp, IConverter convDown)

Parameters

Type	Name	Description
ICollection	col	The underlying ICollection.
IConverter	convUp	The IConverter to view the underlying collection through.
IConverter	convDown	The IConverter to pass items down to the underlying collection through.

Returns

Type	Description
ConverterCollections.ConverterCollection	An ICollection that views the passed collection through the specified IConverter.

GetConcurrentCache(IConcurrentCache, IConverter, IConverter, IConverter, IConverter)

Returns a Converter instance of IConcurrentCache.

Declaration

public static ConverterCollections.ConverterConcurrentCache GetConcurrentCache(IConcurrentCache cache, IConverter convKeyUp, IConverter convKeyDown, IConverter convValUp, IConverter convValDown)

Parameters

Type	Name	Description
IConcurrentCache	cache	The underlying IConcurrentCache.
IConverter	convKeyUp	The IConverter to view the underlying cache's keys through.
IConverter	convKeyDown	The IConverter to use to pass keys down to the underlying cache.
IConverter	convValUp	The IConverter to view the underlying cache's values through.
IConverter	convValDown	The IConverter to use to pass values down to the underlying cache.

Returns

Type	Description
ConverterCollections.ConverterConcurrentCache	An IConcurrentCache that views the keys and values of the passed IConcurrentCache through the specified IConverters.

GetDictionary(IDictionary, IConverter, IConverter, IConverter, IConverter)

Returns a Converter instance of IDictionary.

Declaration

public static ConverterCollections.ConverterDictionary GetDictionary(IDictionary dict, IConverter convKeyUp, IConverter convKeyDown, IConverter convValUp, IConverter convValDown)

Parameters

Type	Name	Description
IDictionary	dict	The underlying IDictionary.
IConverter	convKeyUp	The IConverter to view the underlying dictionary's keys through.
IConverter	convKeyDown	The IConverter to use to pass keys down to the underlying dictionary.
IConverter	convValUp	The IConverter to view the underlying dictionary's values through.
IConverter	convValDown	The IConverter to use to pass values down to the underlying dictionary.

Returns

Type	Description
ConverterCollections.ConverterDictionary	An IDictionary that views the keys and values of the passed dictionary through the specified IConverters.

GetDictionaryEnumerator(IDictionaryEnumerator, IConverter, IConverter)

Returns an instance of IDictionaryEnumerator that uses IConverters to view an underlying enumerator.

Declaration

public static IDictionaryEnumerator GetDictionaryEnumerator(IDictionaryEnumerator enumerator, IConverter convKey, IConverter convVal)

Parameters

Type	Name	Description
IDictionaryEnumerator	enumerator	The underlying IDictionaryEnumerator.
IConverter	convKey	The IConverter to view the underlying IDictionaryEnumerator keys through.
IConverter	convVal	The IConverter to view the underlying IDictionaryEnumerator values through.

Returns

Type	Description
IDictionaryEnumerator	An IDictionaryEnumerator that views the passed enumerator through the specified IConverters.

GetEnumerator(IEnumerator, IConverter)

Returns an instance of IEnumerator that uses an IConverter to view an underlying enumerator.

Declaration

public static IEnumerator GetEnumerator(IEnumerator enumerator, IConverter conv)

Parameters

Type	Name	Description
IEnumerator	enumerator	The underlying IEnumerator.
IConverter	conv	The IConverter to view the underlying IEnumerator through.

Returns

Type	Description
IEnumerator	An IEnumerator that views the passed enumerator through the specified IConverter.

GetInvocableCache(IInvocableCache, IConverter, IConverter, IConverter, IConverter)

Returns a Converter instance of IInvocableCache.

Declaration

public static ConverterCollections.ConverterInvocableCache GetInvocableCache(IInvocableCache cache, IConverter convKeyUp, IConverter convKeyDown, IConverter convValUp, IConverter convValDown)

Parameters

Type	Name	Description
IInvocableCache	cache	The underlying IInvocableCache.
IConverter	convKeyUp	The IConverter to view the underlying cache's keys through.
IConverter	convKeyDown	The IConverter to use to pass keys down to the underlying cache.
IConverter	convValUp	The IConverter to view the underlying cache's values through.
IConverter	convValDown	The IConverter to use to pass values down to the underlying cache.

Returns

Type	Description
ConverterCollections.ConverterInvocableCache	An IInvocableCache that views the keys and values of the passed IInvocableCache through the specified IConverters.

GetNamedCache(INamedCache, IConverter, IConverter, IConverter, IConverter)

Returns a Converter instance of INamedCache.

Declaration

public static ConverterCollections.ConverterNamedCache GetNamedCache(INamedCache cache, IConverter convKeyUp, IConverter convKeyDown, IConverter convValUp, IConverter convValDown)

Parameters

Type	Name	Description
INamedCache	cache	The underlying INamedCache.
IConverter	convKeyUp	The IConverter to view the underlying cache's keys through.
IConverter	convKeyDown	The IConverter to use to pass keys down to the underlying cache.
IConverter	convValUp	The IConverter to view the underlying cache's values through.
IConverter	convValDown	The IConverter to use to pass values down to the underlying cache.

Returns

Type	Description
ConverterCollections.ConverterNamedCache	An INamedCache that views the keys and values of the passed INamedCache through the specified IConverters.

GetObservableCache(IObservableCache, IConverter, IConverter, IConverter, IConverter)

Returns a Converter instance of IObservableCache.

Declaration

public static ConverterCollections.ConverterObservableCache GetObservableCache(IObservableCache cache, IConverter convKeyUp, IConverter convKeyDown, IConverter convValUp, IConverter convValDown)

Parameters

Type	Name	Description
IObservableCache	cache	The underlying IObservableCache.
IConverter	convKeyUp	The IConverter to view the underlying cache's keys through.
IConverter	convKeyDown	The IConverter to use to pass keys down to the underlying cache.
IConverter	convValUp	The IConverter to view the underlying cache's values through.
IConverter	convValDown	The IConverter to use to pass values down to the underlying cache.

Returns

Type	Description
ConverterCollections.ConverterObservableCache	An IObservableCache that views the keys and values of the passed IObservableCache through the specified IConverters.

GetQueryCache(IQueryCache, IConverter, IConverter, IConverter, IConverter)

Returns a Converter instance of IQueryCache.

Declaration

public static ConverterCollections.ConverterQueryCache GetQueryCache(IQueryCache cache, IConverter convKeyUp, IConverter convKeyDown, IConverter convValUp, IConverter convValDown)

Parameters

Type	Name	Description
IQueryCache	cache	The underlying IQueryCache.
IConverter	convKeyUp	The IConverter to view the underlying cache's keys through.
IConverter	convKeyDown	The IConverter to use to pass keys down to the underlying cache.
IConverter	convValUp	The IConverter to view the underlying cache's values through.
IConverter	convValDown	The IConverter to use to pass values down to the underlying cache.

Returns

Type	Description
ConverterCollections.ConverterQueryCache	An IQueryCache that views the keys and values of the passed IQueryCache through the specified IConverters.