Class ConverterCollections.ConverterCacheEntries
A Converter Entry Collection views an underlying entry ICollection through a set of key and value IConverters.
Inherited Members
Namespace: Tangosol.Util
Assembly: Coherence.dll
Syntax
public class ConverterCollections.ConverterCacheEntries : ICollection, IEnumerable
Constructors
ConverterCacheEntries(ICollection, IConverter, IConverter, IConverter, IConverter)
Constructor.
Declaration
public ConverterCacheEntries(ICollection col, IConverter convKeyUp, IConverter convKeyDown, IConverter convValUp, IConverter convValDown)
Parameters
| Type | Name | Description |
|---|---|---|
| ICollection | col | The underlying collection of entries. |
| 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. |
Fields
m_col
The underlying collection of ICacheEntry objects.
Declaration
protected ICollection m_col
Field Value
| Type | Description |
|---|---|
| ICollection |
m_convKeyDown
The IConverter used to pass keys down to the entry collection.
Declaration
protected IConverter m_convKeyDown
Field Value
| Type | Description |
|---|---|
| IConverter |
m_convKeyUp
The IConverter used to view keys stored in the entry collection.
Declaration
protected IConverter m_convKeyUp
Field Value
| Type | Description |
|---|---|
| IConverter |
m_convValDown
The IConverter used to pass values down to the entry collection.
Declaration
protected IConverter m_convValDown
Field Value
| Type | Description |
|---|---|
| IConverter |
m_convValUp
The IConverter used to view values stored in the entry collection.
Declaration
protected IConverter m_convValUp
Field Value
| Type | Description |
|---|---|
| IConverter |
Properties
ConverterKeyDown
The IConverter used to pass keys down to the underlying entries collection.
Declaration
public virtual IConverter ConverterKeyDown { get; }
Property Value
| Type | Description |
|---|---|
| IConverter | The IConverter to the underlying entries' keys. |
ConverterKeyUp
The IConverter used to view the underlying entries' keys through.
Declaration
public virtual IConverter ConverterKeyUp { get; }
Property Value
| Type | Description |
|---|---|
| IConverter | The IConverter from the underlying entries' keys. |
ConverterValueDown
The IConverter used to pass values down to the underlying entries collection.
Declaration
public virtual IConverter ConverterValueDown { get; }
Property Value
| Type | Description |
|---|---|
| IConverter | The IConverter to the underlying entries' values. |
ConverterValueUp
The IConverter used to view the underlying entries' values through.
Declaration
public virtual IConverter ConverterValueUp { get; }
Property Value
| Type | Description |
|---|---|
| IConverter | The IConverter from the underlying entries' values. |
Count
Gets the number of elements contained in the collection.
Declaration
public virtual int Count { get; }
Property Value
| Type | Description |
|---|---|
| int | The number of elements contained in the collection. |
Entries
The underlying collection of ICacheEntry objects.
Declaration
public virtual ICollection Entries { get; }
Property Value
| Type | Description |
|---|---|
| ICollection | The underlying collection of entries. |
IsSynchronized
Gets a value indicating whether access to the collection is synchronized (thread safe).
Declaration
public virtual bool IsSynchronized { get; }
Property Value
| Type | Description |
|---|---|
| bool | true if access to the collection is synchronized (thread safe); otherwise, false. |
SyncRoot
Gets an object that can be used to synchronize access to the collection.
Declaration
public virtual object SyncRoot { get; }
Property Value
| Type | Description |
|---|---|
| object | An object that can be used to synchronize access to the collection. |
Methods
CopyTo(Array, int)
Copies the elements of the ICollection to an array, starting at a particular index.
Declaration
public virtual void CopyTo(Array array, int index)
Parameters
| Type | Name | Description |
|---|---|---|
| Array | array | The one-dimensional array that is the destination of the elements copied from collection. The array must have zero-based indexing. |
| int | index | The zero-based index in array at which copying begins. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | Array is null. |
| ArgumentOutOfRangeException | Index is less than zero. |
| ArgumentException | Array is multidimensional or index is equal to or greater than the length of array or the number of elements in the source collection is greater than the available space from index to the end of the destination array. |
| InvalidCastException | The type of the source collection cannot be cast automatically to the type of the destination array. |
Equals(object)
Compares the specified object with this collection for equality.
Declaration
public override bool Equals(object o)
Parameters
| Type | Name | Description |
|---|---|---|
| object | o | Object to be compared for equality with this collection. |
Returns
| Type | Description |
|---|---|
| bool | true if the specified object is equal to this collection. |
Overrides
GetEnumerator()
Returns an enumerator that iterates through a collection.
Declaration
public virtual IEnumerator GetEnumerator()
Returns
| Type | Description |
|---|---|
| IEnumerator | An IEnumerator object that can be used to iterate through the collection. |
GetHashCode()
Returns the hash code value for this collection.
Declaration
public override int GetHashCode()
Returns
| Type | Description |
|---|---|
| int | The hash code value for this collection. |
Overrides
ToString()
Return a string description for this collection.
Declaration
public override string ToString()
Returns
| Type | Description |
|---|---|
| string | A string description of the collection. |
Overrides
WrapEntry(ICacheEntry)
Wrap an ICacheEntry from the entries collection to make a ConverterCollections.ConverterCacheEntries.ConverterEntry.
Declaration
protected virtual ICacheEntry WrapEntry(ICacheEntry entry)
Parameters
| Type | Name | Description |
|---|---|---|
| ICacheEntry | entry | An ICacheEntry to wrap. |
Returns
| Type | Description |
|---|---|
| ICacheEntry | An ICacheEntry that restricts its type. |
WrapEnumerator(IEnumerator)
Wrap an IEnumerator from the entries collection to make a ConverterCollections.ConverterCacheEnumerator.
Declaration
protected IEnumerator WrapEnumerator(IEnumerator enumerator)
Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerator | enumerator | An IEnumerator to wrap. |
Returns
| Type | Description |
|---|---|
| IEnumerator | A ConverterCacheEnumerator. |