Namespace: Consultingwerk.Framework.Collections
Class 
CharacterDictionary Copy to Clipboard
Parent classes:
Inherits: Consultingwerk.Framework.Base.AblPrimitiveDictionary
Implements: Consultingwerk.Framework.Base.ISupportsListChanged, Consultingwerk.Framework.Base.ISupportsListHash

File:CharacterDictionary
Purpose:A general purpose Dictionary class with a Character as
the key and a Character as the value
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sun Jan 22 14:33:52 CET 2012
Purpose: Constructor for the Dictionary class
Notes:



Top Method Summary
Options Name Purpose
+ Add (character, character) Adds the specified key and value to the dictionary.
+ AddWhenNotContained (character, character) Adds the specified key and value to the dictionary only when it is not yet contained - silently ignores keys that are already contained
+ Clear () Removes all keys and values from the Dictionary
Inherited from Consultingwerk.Framework.Base.AblPrimitiveDictionary
+ LOGICAL ContainsKey (character) Determines whether the Dictionary contains the specified key.
Inherited from Consultingwerk.Framework.Base.AblPrimitiveDictionary
+ LOGICAL ContainsValue (character) Determines whether the Dictionary contains the specified value.
# INTEGER EntryOfKey (character) Determines the posiiton of the specified key in the list of keys
Inherited from Consultingwerk.Framework.Base.AblPrimitiveDictionary
+ Consultingwerk.Framework.Collections.CharacterDictionaryEnumerator GetEnumerator () Returns the Enumerator for the Dictionary
+ CHARACTER GetValue (character) Returns the Value for the specified Key
# InternalAdd (character, character) Adds the specified key and value to the dictionary.
Inherited from Consultingwerk.Framework.Base.AblPrimitiveDictionary
# LOGICAL InternalContainsValue (character) Determines whether the Dictionary contains the specified value.
Inherited from Consultingwerk.Framework.Base.AblPrimitiveDictionary
# CHARACTER InternalGetValue (character) Returns the Value for the specified Key
Inherited from Consultingwerk.Framework.Base.AblPrimitiveDictionary
# InternalSetValue (character, character) Assigns the Value for the specified Key
Inherited from Consultingwerk.Framework.Base.AblPrimitiveDictionary
# OnListChanged (ListChangedEventArgs) Raises the ListChanged event
Inherited from Consultingwerk.Framework.Base.AblPrimitiveDictionary
+ Remove (character) Removes the Key/Value for the specified Key
Inherited from Consultingwerk.Framework.Base.AblPrimitiveDictionary
+ SetValue (character, character) Assigns the Value for the specified Key
# ValidateKey (character) Validates a Key
Inherited from Consultingwerk.Framework.Base.AblPrimitiveDictionary
# ValidateValue (character) Validates a Value
Inherited from Consultingwerk.Framework.Base.AblPrimitiveDictionary

Top Constructor Summary
Options Name Purpose
+ CharacterDictionary () Constructor for the Dictionary class
+ CharacterDictionary (character) Constructor for the Dictionary class
+ CharacterDictionary (character, character) Constructor for the Dictionary class
+ CharacterDictionary (character, character, character, character) Constructor for the Dictionary class

Top Event Summary
Options Name Purpose
+ ListChanged (Object, ListChangedEventArgs) Raised when the List is changed by adding or removing items or clearing the list
Inherited from Consultingwerk.Framework.Base.AblPrimitiveDictionary

Top Property Summary
Options Name Purpose
+ INTEGER Count
Inherited from Consultingwerk.Framework.Base.AblPrimitiveDictionary
+ CHARACTER KeyDelimiter
Inherited from Consultingwerk.Framework.Base.AblPrimitiveDictionary
+ CHARACTER Keys
Inherited from Consultingwerk.Framework.Base.AblPrimitiveDictionary
+ CHARACTER ListHash
Inherited from Consultingwerk.Framework.Base.AblPrimitiveDictionary
+ CHARACTER ValueDelimiter
Inherited from Consultingwerk.Framework.Base.AblPrimitiveDictionary
+ CHARACTER Values
Inherited from Consultingwerk.Framework.Base.AblPrimitiveDictionary


Method Detail
Top

PUBLIC Add (character, character)

Purpose: Adds the specified key and value to the dictionary.
Notes: Throws an InvalidParameterValueException when the dictionary
alredy contains the key (ContainsKey (pcKey) = TRUE)

Parameters:
pcKey CHARACTER
The key for the key/value pair to add to the dictionary
pValue CHARACTER
The value for the key/value pair to add to the dictionary
Top

PUBLIC AddWhenNotContained (character, character)

Purpose: Adds the specified key and value to the dictionary only
when it is not yet contained - silently ignores keys that
are already contained
Notes: Throws an InvalidParameterValueException when the dictionary
alredy contains the key (ContainsKey (pcKey) = TRUE)

Parameters:
pcKey CHARACTER
The key for the key/value pair to add to the dictionary
pValue CHARACTER
The value for the key/value pair to add to the dictionary
Top

PUBLIC Clear ()

Inherited from Consultingwerk.Framework.Base.AblPrimitiveDictionary
Purpose: Removes all keys and values from the Dictionary
Notes: Raisees the ListChanged event

Top

PUBLIC LOGICAL ContainsKey (character)

Inherited from Consultingwerk.Framework.Base.AblPrimitiveDictionary
Purpose: Determines whether the Dictionary contains the specified key.
Notes:

Parameters:
pcKey CHARACTER
The key to locate in the Dictionary
Returns LOGICAL
Logical value indicating if the dictionary contains the specified key
Top

PUBLIC LOGICAL ContainsValue (character)

Purpose: Determines whether the Dictionary contains the specified value.
Notes:

Parameters:
pValue CHARACTER
The value to locate in the Dictionary
Returns LOGICAL
Logical value indicating if the value is contained in the Dictionary
Top

PROTECTED INTEGER EntryOfKey (character)

Inherited from Consultingwerk.Framework.Base.AblPrimitiveDictionary
Purpose: Determines the posiiton of the specified key in the list of keys
Notes:

Parameters:
pcKey CHARACTER
The Key to locate in the Keys
Returns INTEGER
The position of the specified in the list of keys
Top

PUBLIC Consultingwerk.Framework.Collections.CharacterDictionaryEnumerator GetEnumerator ()

Purpose: Returns the Enumerator for the Dictionary
Notes:

Returns Consultingwerk.Framework.Collections.CharacterDictionaryEnumerator
The Enumerator instance
Top

PUBLIC CHARACTER GetValue (character)

Purpose: Returns the Value for the specified Key
Notes:

Parameters:
pcKey CHARACTER
The value to locate in the Dictionary
Returns CHARACTER
The value for the specified key
Top

PROTECTED InternalAdd (character, character)

Inherited from Consultingwerk.Framework.Base.AblPrimitiveDictionary
Purpose: Adds the specified key and value to the dictionary.
Notes: Internal method, used by derived class (which converts from the
original value type to the CHARACTER value expected by this method)

Parameters:
pcKey CHARACTER
The key for the key/value pair to add to the dictionary
pcValue CHARACTER
The value for the key/value pair to add to the dictionary
Top

PROTECTED LOGICAL InternalContainsValue (character)

Inherited from Consultingwerk.Framework.Base.AblPrimitiveDictionary
Purpose: Determines whether the Dictionary contains the specified value.
Notes: Internal method, used by derived class (which converts from the
original value type to the CHARACTER value expected by this method)

Parameters:
pcValue CHARACTER
The value to locate in the Dictionary
Returns LOGICAL
Logical value indicating if the Dictionary contains the specified value
Top

PROTECTED CHARACTER InternalGetValue (character)

Inherited from Consultingwerk.Framework.Base.AblPrimitiveDictionary
Purpose: Returns the Value for the specified Key
Notes: Internal method, used by derived class (which converts from the
original value type to the CHARACTER value expected by this method)

Parameters:
pcKey CHARACTER
The value to locate in the Dictionary
Returns CHARACTER
The value for the specified key
Top

PROTECTED InternalSetValue (character, character)

Inherited from Consultingwerk.Framework.Base.AblPrimitiveDictionary
Purpose: Assigns the Value for the specified Key
Notes: Internal method, used by derived class (which converts from the
original value type to the CHARACTER value expected by this method)

Parameters:
pcKey CHARACTER
The value to locate in the Dictionary
pcValue CHARACTER
The value to assign for the Key in the Dictionary
Top

PROTECTED OnListChanged (ListChangedEventArgs)

Inherited from Consultingwerk.Framework.Base.AblPrimitiveDictionary
Purpose: Raises the ListChanged event
Notes:

Parameters:
e Consultingwerk.Framework.Base.ListChangedEventArgs
The ListChangedEventArgs object instance with the data of the ListChanged event
Top

PUBLIC Remove (character)

Inherited from Consultingwerk.Framework.Base.AblPrimitiveDictionary
Purpose: Removes the Key/Value for the specified Key
Notes: Internal method, used by derived class (which converts from the
original value type to the CHARACTER value expected by this method)

Parameters:
pcKey CHARACTER
The value to remove from the Dictionary
Top

PUBLIC SetValue (character, character)

Purpose: Assigns the Value for the specified Key
Notes:

Parameters:
pcKey CHARACTER
The value to locate in the Dictionary
pValue CHARACTER
The value to assign for the Key in the Dictionary
Top

PROTECTED ValidateKey (character)

Inherited from Consultingwerk.Framework.Base.AblPrimitiveDictionary
Purpose: Validates a Key
Notes:

Parameters:
pcKey CHARACTER
The key to validate
Top

PROTECTED ValidateValue (character)

Inherited from Consultingwerk.Framework.Base.AblPrimitiveDictionary
Purpose: Validates a Value
Notes:

Parameters:
pcValue CHARACTER
The value to validate


Constructor Detail
Top

PUBLIC CharacterDictionary ()

Purpose: Constructor for the Dictionary class
Notes:

Top

PUBLIC CharacterDictionary (character)

Purpose: Constructor for the Dictionary class
Notes:

Parameters:
pcDelimiter CHARACTER
The Delimiter to use for Keys and Values
Top

PUBLIC CharacterDictionary (character, character)

Purpose: Constructor for the Dictionary class
Notes: Defaults to the comma (",") as the delimiter for Keys and Values

Parameters:
pcKeys CHARACTER
The initial list of Keys
pcValues CHARACTER
The initial list of Values
Top

PUBLIC CharacterDictionary (character, character, character, character)

Purpose: Constructor for the Dictionary class
Notes:

Parameters:
pcKeys CHARACTER
The initial list of Keys
pcKeyDelimiter CHARACTER
The delimiter for the Keys
pcValues CHARACTER
The initial list of Values
pcValueDelimiter CHARACTER
The delimiter for the Values


Event Detail
Top

PUBLIC ListChanged (Object, ListChangedEventArgs)

Inherited from Consultingwerk.Framework.Base.AblPrimitiveDictionary
Purpose: Raised when the List is changed by adding or removing items or
clearing the list
Notes:

Parameters:
sender Progress.Lang.Object
The sender of the event
e Consultingwerk.Framework.Base.ListChangedEventArgs
The ListChangedEventArgs object instance with the data of the ListChanged event


Property Detail
Top

PUBLIC INTEGER Count

Inherited from Consultingwerk.Framework.Base.AblPrimitiveDictionary

Returns INTEGER
Top

PUBLIC CHARACTER KeyDelimiter

Inherited from Consultingwerk.Framework.Base.AblPrimitiveDictionary

Returns CHARACTER
Top

PUBLIC CHARACTER Keys

Inherited from Consultingwerk.Framework.Base.AblPrimitiveDictionary

Returns CHARACTER
Top

PUBLIC CHARACTER ListHash

Inherited from Consultingwerk.Framework.Base.AblPrimitiveDictionary

Returns CHARACTER
Top

PUBLIC CHARACTER ValueDelimiter

Inherited from Consultingwerk.Framework.Base.AblPrimitiveDictionary

Returns CHARACTER
Top

PUBLIC CHARACTER Values

Inherited from Consultingwerk.Framework.Base.AblPrimitiveDictionary

Returns CHARACTER


©2006-2020 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       27.09.2022 23:44:48