Class TCustomDictionary

Unit

Generics.Collections

Declaration

type TCustomDictionary<TKey,TValue,THashFactory> = class abstract(TObject)

Description

bug #24283 and #24097 (forward declaration) - should be: TCustomDictionary<CUSTOM_DICTIONARY_CONSTRAINTS> = class(TEnumerable<TPair<TKey, TValue> >);

Hierarchy

• TObject
• TCustomDictionary

Overview

Internal Types

	PDictionaryPair = ˆTDictionaryPair;
	PKey = ˆTKey;
	PValue = ˆTValue;
	TDictionaryPair = TPair<TKey, TValue>;
	THashFactoryClass = THashFactory;

Fields

	FEqualityComparer: IEqualityComparer<TKey>;
	FKeys: TEnumerable<TKey>;
	FValues: TEnumerable<TValue>;
	FMaxLoadFactor: single;
	FOnKeyNotify: TCollectionNotifyEvent<TKey>;
	FOnValueNotify: TCollectionNotifyEvent<TValue>;
	FItemsLength: SizeInt;

Methods

	procedure SetCapacity(ACapacity: SizeInt); virtual; abstract;
	function DoGetEnumerator: TEnumerator<TDictionaryPair>; virtual; abstract;
	procedure SetMaxLoadFactor(AValue: single); virtual; abstract;
	function GetLoadFactor: single; virtual; abstract;
	function GetCapacity: SizeInt; virtual; abstract;
	procedure Clear; virtual; abstract;
	procedure Add(constref APair: TPair<TKey, TValue>); virtual; abstract;
	function ToArray: TArray<TDictionaryPair>; virtual; final; overload;
	constructor Create; virtual; overload;
	constructor Create(ACapacity: SizeInt); virtual; overload;
	constructor Create(ACapacity: SizeInt; const AComparer: IEqualityComparer<TKey>); virtual; overload;
	constructor Create(const AComparer: IEqualityComparer<TKey>); overload;
	constructor Create(ACollection: TEnumerable<TDictionaryPair>); virtual; overload;
	constructor Create(ACollection: TEnumerable<TDictionaryPair>; const AComparer: IEqualityComparer<TKey>); virtual; overload;
	destructor Destroy; override;
	procedure UpdateItemsThreshold(ASize: SizeInt); virtual; abstract;
	procedure KeyNotify(constref AKey: TKey; ACollectionNotification: TCollectionNotification); virtual;
	procedure ValueNotify(constref AValue: TValue; ACollectionNotification: TCollectionNotification); virtual;
	procedure PairNotify(constref APair: TDictionaryPair; ACollectionNotification: TCollectionNotification); inline;
	procedure SetValue(var AValue: TValue; constref ANewValue: TValue);

Properties

	property MaxLoadFactor: single read FMaxLoadFactor write SetMaxLoadFactor;
	property LoadFactor: single read GetLoadFactor;
	property Capacity: SizeInt read GetCapacity write SetCapacity;
	property OnKeyNotify: TCollectionNotifyEvent<TKey> read FOnKeyNotify write FOnKeyNotify;
	property OnValueNotify: TCollectionNotifyEvent<TValue> read FOnValueNotify write FOnValueNotify;
	property Count: SizeInt read FItemsLength;

Description

Internal Types

	PDictionaryPair = ˆTDictionaryPair;

	PKey = ˆTKey;

	PValue = ˆTValue;

	TDictionaryPair = TPair<TKey, TValue>;
workaround... no generics types in generics types

	THashFactoryClass = THashFactory;

Fields

	FEqualityComparer: IEqualityComparer<TKey>;

	FKeys: TEnumerable<TKey>;

	FValues: TEnumerable<TValue>;

	FMaxLoadFactor: single;

	FOnKeyNotify: TCollectionNotifyEvent<TKey>;

	FOnValueNotify: TCollectionNotifyEvent<TValue>;

	FItemsLength: SizeInt;
FItemsLength must be declared at the end of TCustomDictionary

Methods

	procedure SetCapacity(ACapacity: SizeInt); virtual; abstract;

	function DoGetEnumerator: TEnumerator<TDictionaryPair>; virtual; abstract;
bug #24283. workaround for this class because can't inherit from TEnumerable

	procedure SetMaxLoadFactor(AValue: single); virtual; abstract;
override;

	function GetLoadFactor: single; virtual; abstract;

	function GetCapacity: SizeInt; virtual; abstract;

	procedure Clear; virtual; abstract;

	procedure Add(constref APair: TPair<TKey, TValue>); virtual; abstract;

	function ToArray: TArray<TDictionaryPair>; virtual; final; overload;

	constructor Create; virtual; overload;
override; final; // bug #24283

	constructor Create(ACapacity: SizeInt); virtual; overload;

	constructor Create(ACapacity: SizeInt; const AComparer: IEqualityComparer<TKey>); virtual; overload;

	constructor Create(const AComparer: IEqualityComparer<TKey>); overload;

	constructor Create(ACollection: TEnumerable<TDictionaryPair>); virtual; overload;

	constructor Create(ACollection: TEnumerable<TDictionaryPair>; const AComparer: IEqualityComparer<TKey>); virtual; overload;

	destructor Destroy; override;

	procedure UpdateItemsThreshold(ASize: SizeInt); virtual; abstract;

	procedure KeyNotify(constref AKey: TKey; ACollectionNotification: TCollectionNotification); virtual;

	procedure ValueNotify(constref AValue: TValue; ACollectionNotification: TCollectionNotification); virtual;

	procedure PairNotify(constref APair: TDictionaryPair; ACollectionNotification: TCollectionNotification); inline;

	procedure SetValue(var AValue: TValue; constref ANewValue: TValue);

Properties

	property MaxLoadFactor: single read FMaxLoadFactor write SetMaxLoadFactor;

	property LoadFactor: single read GetLoadFactor;

	property Capacity: SizeInt read GetCapacity write SetCapacity;

	property OnKeyNotify: TCollectionNotifyEvent<TKey> read FOnKeyNotify write FOnKeyNotify;

	property OnValueNotify: TCollectionNotifyEvent<TValue> read FOnValueNotify write FOnValueNotify;

	property Count: SizeInt read FItemsLength;