Class NamedCollection<T>

Namespace

NanoByte.Common.Collections

Assembly

NanoByte.Common.dll

A keyed collection (pseudo-dictionary) of INamed objects. Case-insensitive!

public class NamedCollection<T> : KeyedCollection<string, T>, ICloneable<NamedCollection<T>> where T : INamed

Type Parameters

T

Inheritance

object

Collection<T>

KeyedCollection<string, T>

NamedCollection<T>

Implements

ICloneable<NamedCollection<T>>

Extension Methods

BinaryStorage.SaveBinary<T>(T, Stream)

BinaryStorage.SaveBinary<T>(T, string)

JsonStorage.SaveJson<T>(T, Stream)

JsonStorage.SaveJson<T>(T, string)

JsonStorage.ToJsonString<T>(T)

XmlStorage.SaveXml<T>(T, Stream, string?)

XmlStorage.SaveXml<T>(T, string, string?)

XmlStorage.ToXmlString<T>(T, string?)

UpdateUtils.To<T>(T, ref T, Action)

UpdateUtils.To<T>(T, ref T, ref bool)

UpdateUtils.To<T>(T, ref T, ref bool, ref bool)

UpdateUtils.To<TIn, TOut>(TIn, Func<TIn, TOut>)

ConversionUtils.ConvertToString<TType>(TType)

CollectionExtensions.AddIfNew<T>(ICollection<T>, T)

CollectionExtensions.Add<TCollection, TElements>(ICollection<TCollection>, IEnumerable<TElements>)

CollectionExtensions.RemoveAll<T>(ICollection<T>, Func<T, bool>)

CollectionExtensions.Remove<TCollection, TElements>(ICollection<TCollection>, IEnumerable<TElements>)

DictionaryExtensions.ToMultiDictionary<TSource, TKey, TValue>(IEnumerable<TSource>, Func<TSource, TKey>, Func<TSource, TValue>)

EnumerableExtensions.ContainsAny<T>(IEnumerable<T>, IEnumerable<T>, IEqualityComparer<T>?)

EnumerableExtensions.ContainsOrEmpty<T>(IEnumerable<T>, T)

EnumerableExtensions.DistinctBy<T, TKey>(IEnumerable<T>, Func<T, TKey>)

EnumerableExtensions.Except<T>(IEnumerable<T>, Func<T, bool>)

EnumerableExtensions.Except<T>(IEnumerable<T>, T)

EnumerableExtensions.GetSequencedHashCode<T>(IEnumerable<T>, IEqualityComparer<T>?)

EnumerableExtensions.GetUnsequencedHashCode<T>(IEnumerable<T>, IEqualityComparer<T>?)

EnumerableExtensions.MaxBy<T, TValue>(IEnumerable<T>, Func<T, TValue>, IComparer<TValue>?)

EnumerableExtensions.MinBy<T, TValue>(IEnumerable<T>, Func<T, TValue>, IComparer<TValue>?)

EnumerableExtensions.Permutate<T>(IEnumerable<T>)

EnumerableExtensions.SequencedEquals<T>(IEnumerable<T>, IEnumerable<T>, IEqualityComparer<T>?)

EnumerableExtensions.TopologicalSort<T>(IEnumerable<T>, Func<T, IEnumerable<T>>)

EnumerableExtensions.TrySelect<TSource, TResult, TException>(IEnumerable<TSource>, Func<TSource, TResult>, Action<TException>)

EnumerableExtensions.UnsequencedEquals<T>(IEnumerable<T>, IEnumerable<T>, IEqualityComparer<T>?)

Bucketizer.Bucketize<T>(IEnumerable<T>)

Bucketizer.Bucketize<TElement, TValue>(IEnumerable<TElement>, Func<TElement, TValue>)

ExceptionUtils.TryAnyAsync<T>(IEnumerable<T>, Func<T, Task>)

ExceptionUtils.TryAny<T>(IEnumerable<T>, Action<T>)

ListExtensions.AddRange<TList, TElements>(IList<TList>, IEnumerable<TElements>)

ListExtensions.GetAddedElements<T>(IReadOnlyList<T>?, IReadOnlyList<T>?, IComparer<T>)

JsonStorage.ReparseAsJson<T>(object)

JsonStorage.ReparseAsJson<T>(object, T)

Remarks

Elements are automatically maintained in an alphabetically sorted order. Suitable for XML serialization.

Constructors

NamedCollection()

A keyed collection (pseudo-dictionary) of INamed objects. Case-insensitive!

public NamedCollection()

Remarks

Elements are automatically maintained in an alphabetically sorted order. Suitable for XML serialization.

NamedCollection(IEnumerable<T>)

Creates a new named collection pre-filled with elements.

public NamedCollection(IEnumerable<T> elements)

Parameters

elements IEnumerable<T>

The elements to pre-fill the collection with. Must all have unique Names!

Methods

ClearItems()

Removes all elements from the System.Collections.ObjectModel.KeyedCollection<TKey, TItem>.

protected override void ClearItems()

Clone()

Creates a shallow copy of this collection (elements are not cloned).

public virtual NamedCollection<T> Clone()

Returns

NamedCollection<T>

The cloned collection.

GetKeyForItem(T)

When implemented in a derived class, extracts the key from the specified element.

protected override string GetKeyForItem(T item)

Parameters

item T

The element from which to extract the key.

Returns

string

The key for the specified element.

InsertItem(int, T)

Inserts an element into the System.Collections.ObjectModel.KeyedCollection<TKey, TItem> at the specified index.

protected override void InsertItem(int index, T item)

Parameters

index int

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

item T

The object to insert.

Exceptions

ArgumentOutOfRangeException

index is less than 0.-or-index is greater than System.Collections.ObjectModel.Collection<T>.Count.

RemoveItem(int)

Removes the element at the specified index of the System.Collections.ObjectModel.KeyedCollection<TKey, TItem>.

protected override void RemoveItem(int index)

Parameters

index int

The index of the element to remove.

Rename(T, string)

Renames an element in the list. Renaming an element in the list directly (without using this method) will prevent lookups from working properly!

[CollectionAccess(CollectionAccessType.ModifyExistingContent)]
public void Rename(T element, string newName)

Parameters

element T

The element to rename.

newName string

The new Name for the element.

Exceptions

KeyNotFoundException

The element is not in the collection.

InvalidOperationException

The newName is already taken by another element in the collection.

SetItem(int, T)

Replaces the item at the specified index with the specified item.

protected override void SetItem(int index, T item)

Parameters

index int

The zero-based index of the item to be replaced.

item T

The new item.

Events

CollectionChanged

public event Action<object>? CollectionChanged

Event Type

Action<object>