PersistentDictionaryTKey, TValue Class

A dictionary that maps keys to values and is persistent. Persistence means that an instance of this type, once created, cannot be changed. Methods like Add(TKey, TValue) return a new instance instead of modifying the one on which they are called. The new instance shares much of its structure with the original, so modifications are still efficient. This class is useful in multithreaded applications. An instance of this type cannot be created directly. The Empty field contains an empty instance with which to start.

Inheritance Hierarchy

SystemObject
AGI.Foundation.Infrastructure.ThreadingPersistentDictionaryNodeTKey, TValue
AGI.Foundation.Infrastructure.ThreadingPersistentDictionaryTKey, TValue

Namespace: AGI.Foundation.Infrastructure.Threading
Assembly: AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 24.3.420.0 (24.3.420.0)

Syntax

C++

Copy

public abstract class PersistentDictionary<TKey, TValue> : PersistentDictionaryNode<TKey, TValue>, 
	IEnumerable<KeyValuePair<TKey, TValue>>, IEnumerable

Public MustInherit Class PersistentDictionary(Of TKey, TValue)
	Inherits PersistentDictionaryNode(Of TKey, TValue)
	Implements IEnumerable(Of KeyValuePair(Of TKey, TValue)), 
	IEnumerable

generic<typename TKey, typename TValue>
public ref class PersistentDictionary abstract : public PersistentDictionaryNode<TKey, TValue>, 
	IEnumerable<KeyValuePair<TKey, TValue>>, IEnumerable

[<AbstractClassAttribute>]
type PersistentDictionary<'TKey, 'TValue> =  
    class
        inherit PersistentDictionaryNode<'TKey, 'TValue>
        interface IEnumerable<KeyValuePair<'TKey, 'TValue>>
        interface IEnumerable
    end

Type Parameters

TKey: The type of the key in the dictionary.
TValue: The type of the value in the dictionary.

The PersistentDictionaryTKey, TValue type exposes the following members.

Constructors

	Name	Description
	PersistentDictionaryTKey, TValue	Initializes a new instance of the PersistentDictionaryTKey, TValue class

Top

Properties

	Name	Description
	Count	Gets the number of elements in this dictionary.
	Item	Gets the value corresponding to the specified key. Throws KeyNotFoundException if the key does not exist in the dictionary.
	Keys	Gets a read-only collection of keys in the dictionary.
	Values	Gets a read-only collection of values in the dictionary.

Top

Methods

	Name	Description
	Add(TKey, TValue)	Adds a specified key/value pair to the dictionary. If a value with the specified key already exists, it is replaced. This method does not modify the dictionary on which it is called but instead returns a new dictionary containing the added element.
	Add(TKey, TValue, PersistentDictionaryAddResult)	Adds a specified key/value pair to the dictionary, and returns a value indicating whether the key was newly added to the dictionary or it already existed and the value was replaced. This method does not modify the dictionary on which it is called but instead returns a new dictionary containing the added element.
	ContainsKey	Determines if a specified key exists in the dictionary.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetEnumerator	Gets an enumerator for enumerating over the key/value pairs in the dictionary.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Remove	Removes an item with the specified key from the dictionary. This method does not modify the instance on which it is called but instead returns a new instance with the element removed. If the key does not exist in the dictionary, this method returns the instance on which it is called.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TryGetValue	Gets the value in the dictionary corresponding to the given key.

Top

Fields

	Name	Description
	Empty	An empty dictionary.

Top

Reference

AGI.Foundation.Infrastructure.Threading Namespace

PersistentDictionaryAddLanguageSpecificTextSet("LST207588C1_0?cs=&lt;|vb=(Of |cpp=&lt;|fs=&lt;'|nu=(");TKey, TValueAddLanguageSpecificTextSet("LST207588C1_1?cs=&gt;|vb=)|cpp=&gt;|fs=&gt;|nu=)"); Class

Type Parameters

Reference

PersistentDictionaryTKey, TValue Class