System.Collections.ObjectModel

Class KeyedCollection<TKey,TItem>

java.lang.Object

System.Collections.ObjectModel.Collection<TItem>

System.Collections.ObjectModel.KeyedCollection<TKey,TItem>

Type Parameters:

TKey - The type of keys in the collection.

TItem - The type of items in the collection.

All Implemented Interfaces:

java.lang.Iterable<TItem>

public abstract class KeyedCollection<TKey,TItem>
extends Collection<TItem>

Provides the abstract base class for a collection whose keys are embedded in the values.

Author:

Halofreak1990

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	KeyedCollection()
protected	KeyedCollection(IEqualityComparer<TKey> comparer)
protected	KeyedCollection(IEqualityComparer<TKey> comparer, int dictionaryCreationThreshold)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	ChangeItemKey(TItem item, TKey newKey) Changes the key associated with the specified element in the lookup dictionary.
protected void	ClearItems() Removes all elements from the Collection<>.
boolean	Contains(TKey key)
TItem	get(TKey key) Gets the element with the specified key.
IEqualityComparer<TKey>	getComparer()
protected java.util.Map<TKey,TItem>	getDictionary()
protected abstract TKey	GetKeyForItem(TItem item)
protected void	InsertItem(int index, TItem item) Inserts an element into the Collection<> at the specified index.
boolean	Remove(TKey key)
protected void	RemoveItem(int index) Removes the element at the specified index of the Collection<>.
protected void	SetItem(int index, TItem item) Replaces the element at the specified index.

Methods inherited from class System.Collections.ObjectModel.Collection

Add, Clear, Count, get, getItems, IndexOf, Insert, iterator, Remove, set

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeyedCollection

protected KeyedCollection()

KeyedCollection

protected KeyedCollection(IEqualityComparer<TKey> comparer)

KeyedCollection

protected KeyedCollection(IEqualityComparer<TKey> comparer,
               int dictionaryCreationThreshold)

Method Detail

getComparer

public IEqualityComparer<TKey> getComparer()

getDictionary

protected java.util.Map<TKey,TItem> getDictionary()

get

public TItem get(TKey key)

Gets the element with the specified key.

Parameters:

key - The key of the element to get.

Returns:

The element with the specified key. If an element with the specified key is not found, an exception is thrown.

Throws:

ArgumentNullException - key is null.

KeyNotFoundException - An element with the specified key does not exist in the collection.

ChangeItemKey

protected void ChangeItemKey(TItem item,
                 TKey newKey)

Changes the key associated with the specified element in the lookup dictionary.

Parameters:

item - The element to change the key of.

newKey - The new key for item.

Throws:

ArgumentNullException - item is null.-or-newKey is null.

ArgumentException - item is not found.-or-newKey already exists in the System.Collections.ObjectModel.KeyedCollection.

ClearItems

protected void ClearItems()

Description copied from class: Collection

Removes all elements from the Collection<>.

Overrides:

ClearItems in class Collection<TItem>

Contains

public boolean Contains(TKey key)

Parameters:

key -

Returns:

GetKeyForItem

protected abstract TKey GetKeyForItem(TItem item)

InsertItem

protected void InsertItem(int index,
              TItem item)

Description copied from class: Collection

Inserts an element into the Collection<> at the specified index.

Overrides:

InsertItem in class Collection<TItem>

Parameters:

index - The object to insert. The value can be null for reference types.

item - The zero-based index at which item should be inserted.

Remove

public boolean Remove(TKey key)

RemoveItem

protected void RemoveItem(int index)

Description copied from class: Collection

Removes the element at the specified index of the Collection<>.

Overrides:

RemoveItem in class Collection<TItem>

Parameters:

index - The zero-based index of the element to remove.

SetItem

protected void SetItem(int index,
           TItem item)

Description copied from class: Collection

Replaces the element at the specified index.

Overrides:

SetItem in class Collection<TItem>

Parameters:

index - The zero-based index of the element to replace.

item - The new value for the element at the specified index. The value can be null for reference types.