Click here to Skip to main content
15,881,852 members
Articles / Programming Languages / C#

A Concurrent Collection: a MultiMap Generic Collection Class in C# - Part 2

Rate me:
Please Sign up or sign in to vote.
4.87/5 (19 votes)
5 Jun 2009CPOL10 min read 101.6K   3.4K   73  
MultiMap is similar to a .NET Dictionary collection type, but accepts duplicate Key,Value pairs during addition. The MultiMap collection is also a concurrent collection.
<?xml version="1.0"?>
<doc>
    <assembly>
        <name>MultiMap</name>
    </assembly>
    <members>
        <member name="T:BK.Util.MultimapBK`2">
            <summary>
            A Generic Dictionary collection type that can store multiple values for the same key.
            </summary>
            <typeparam name="Key"></typeparam>
            <typeparam name="Value"></typeparam>
        </member>
        <member name="M:BK.Util.MultimapBK`2.#ctor">
            <summary>
            Construction of Multi map
            </summary>
        </member>
        <member name="M:BK.Util.MultimapBK`2.GetEnumerator">
            <summary>
            Gets the Enumerator
            </summary>
            <returns></returns>
        </member>
        <member name="M:BK.Util.MultimapBK`2.#ctor(BK.Util.MultimapBK{`0,`1}@)">
            <summary>
            Construction copying from another Multi map
            </summary>
            <param name="DictToCopy"></param>
        </member>
        <member name="M:BK.Util.MultimapBK`2.Add(`0,`1)">
            <summary>
            Adds an element to the Multi map.
            </summary>
            <param name="KeyElement"></param>
            <param name="ValueElement"></param>
        </member>
        <member name="M:BK.Util.MultimapBK`2.GetFirstItem(`0)">
            <summary>
            Gets the first Item in the Multi map.
            </summary>
            <param name="ItemToFind"></param>
            <returns></returns>
        </member>
        <member name="M:BK.Util.MultimapBK`2.GetNextItem(`0)">
            <summary>
            Gets the Next Item in Multi map.  If this method is called first, it returns first item.
            </summary>
            <param name="ItemToFind"></param>
            <returns></returns>
        </member>
        <member name="M:BK.Util.MultimapBK`2.GetCurrentItem(`0)">
            <summary>
            Gets the Current value in the list of values for the searched Key
            </summary>
            <param name="ItemToFind"></param>
            <returns></returns>
        </member>
        <member name="M:BK.Util.MultimapBK`2.GetNthItem(System.Int32)">
            <summary>
            Gets the Nth Item in Multi map.  
            </summary>
            <param name="ItemNumber"></param>
            <returns></returns>
        </member>
        <member name="M:BK.Util.MultimapBK`2.GetForKey(`0,System.Collections.Generic.KeyValuePair{`0,BK.Util.ValueItem{`0,`1}}@)">
            <summary>
            Gets the Item in Multi map based on Key passed. 
            </summary>
            <param name="KeyItem"></param>
            <param name="keyValuePair"></param>
            <returns></returns>
        </member>
        <member name="M:BK.Util.MultimapBK`2.GetNthKey(System.Int32,`0@)">
            <summary>
            
            </summary>
            <param name="Index"></param>
            <param name="NthKey"></param>
            <returns></returns>
        </member>
        <member name="M:BK.Util.MultimapBK`2.MoveToNextItem(`0)">
            <summary>
            Move to next Value for the specified key
            </summary>
            <param name="ItemToFind"></param>
            <returns></returns>
        </member>
        <member name="M:BK.Util.MultimapBK`2.ResetToFirstItem(`0)">
            <summary>
            Move the pointer to the first item for the specified key
            </summary>
            <param name="ItemToFind"></param>
        </member>
        <member name="M:BK.Util.MultimapBK`2.Iterate(`0)">
            <summary>
            Iterates through all the values for the Key one by one.
            </summary>
            <param name="ItemToFind"></param>
            <returns></returns>
        </member>
        <member name="M:BK.Util.MultimapBK`2.DeleteAll(`0)">
            <summary>
            Removes the Key and all the values for an item.
            </summary>
            <param name="KeyElement"></param>
        </member>
        <member name="M:BK.Util.MultimapBK`2.Delete(`0,`1)">
            <summary>
            Deletes one Key and one Value from the Multi map.
            </summary>
            <param name="KeyElement"></param>
            <param name="ValueElement"></param>
        </member>
        <member name="M:BK.Util.MultimapBK`2.Remove(`0)">
            <summary>
            Removes an Item from the collection.
            </summary>
            <param name="KeyToRemove"></param>
        </member>
        <member name="M:BK.Util.MultimapBK`2.Remove(`0,System.Int32)">
            <summary>
            Removes an Item from the collection.  It waits for a timeout to be succesful.
            </summary>
            <param name="KeyToRemove"></param>
            <param name="TimeOut"></param>
        </member>
        <member name="M:BK.Util.MultimapBK`2.Remove(`0,`1)">
            <summary>
            Removes an Item, Value combination.
            </summary>
            <param name="KeyToRemove"></param>
            <param name="ValueToRemove"></param>
            <returns></returns>
        </member>
        <member name="M:BK.Util.MultimapBK`2.Remove(`0,`1,System.Int32)">
            <summary>
            Removes an Item, Value combination from Multimap
            </summary>
            <param name="KeyToRemove"></param>
            <param name="ValueToRemove"></param>
            <param name="TimeOut"></param>
            <returns></returns>
        </member>
        <member name="M:BK.Util.MultimapBK`2.Clear">
            <summary>
            Clears all the elements in the collection.
            </summary>
        </member>
        <member name="M:BK.Util.MultimapBK`2.Dispose">
            <summary>
            Disposes all the objects stored in the collection.
            </summary>
        </member>
        <member name="M:BK.Util.MultimapBK`2.Finalize">
            <summary>
            Finalizer
            </summary>
        </member>
        <member name="T:BK.Util.MultimapBK`2.MultimapEnum">
            <summary>
            Enumerator class for the Multi map
            </summary>
        </member>
        <member name="M:BK.Util.MultimapBK`2.MultimapEnum.MoveNext">
            <summary>
            Move to the next Item
            </summary>
            <returns></returns>
        </member>
        <member name="M:BK.Util.MultimapBK`2.MultimapEnum.Reset">
            <summary>
            Reset to the first Item
            </summary>
        </member>
        <member name="M:BK.Util.MultimapBK`2.MultimapEnum.Dispose">
            <summary>
            Dispose the object
            </summary>
        </member>
        <member name="P:BK.Util.MultimapBK`2.MultimapEnum.Current">
            <summary>
            Returns Current Element
            </summary>
        </member>
        <member name="T:BK.Util.ValueItem`2">
            <summary>
            Contains Key and Value(s). i.e., Value.First, Value.Next and so on
            </summary>
            <typeparam name="Key"></typeparam>
            <typeparam name="Value"></typeparam>
        </member>
        <member name="M:BK.Util.ValueItem`2.MoveNext">
            <summary>
            Move to Next Item
            </summary>
            <returns></returns>
        </member>
        <member name="M:BK.Util.ValueItem`2.Reset">
            <summary>
            Reset to first Item. 
            </summary>
        </member>
        <member name="P:BK.Util.ValueItem`2.First">
            <summary>
            Returns the first Item
            </summary>
        </member>
        <member name="P:BK.Util.ValueItem`2.Current">
            <summary>
            Return Current Item
            </summary>
        </member>
        <member name="P:BK.Util.ValueItem`2.Next">
            <summary>
            Returns the Next Item
            </summary>
        </member>
        <member name="T:BK.Util.MultiMapBKException">
            <summary>
            The class BK.Util.MultiMap always throws one exception type - MultiMapBKException
            </summary>
        </member>
        <member name="M:BK.Util.MultiMapBKException.#ctor(System.Exception,System.String)">
            <summary>
            Constructor of Exception class
            </summary>
            <param name="ExceptionParam"></param>
            <param name="ExMessage"></param>
            
        </member>
        <member name="M:BK.Util.MultiMapBKException.#ctor">
            <summary>
            Default Constructor of Exception class
            </summary>
        </member>
        <member name="M:BK.Util.MultiMapBKException.#ctor(System.String)">
            <summary>
             Constructor of Exception class
            </summary>
            <param name="exMessage"></param>
        </member>
        <member name="M:BK.Util.MultiMapBKException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
            <summary>
            Multimap Exception constructor
            </summary>
            <param name="seInfo"></param>
            <param name="seCtxt"></param>
        </member>
    </members>
</doc>

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


Written By
Software Developer (Senior)
United States United States
This member has not yet provided a Biography. Assume it's interesting and varied, and probably something to do with programming.

Comments and Discussions