[This is preliminary documentation and is subject to change.]
A collection of metadata entries, addressable by pairs of string group/key names.
Group names, key names, and values may not be null.
Namespace: fCraftAssembly: fCraft (in fCraft.dll) Version: 0.6.2.4 (0.6.2.4)
Syntax
| C# |
public sealed class MetadataCollection<TValue> : ICollection<MetadataEntry<TValue>>, IEnumerable<MetadataEntry<TValue>>, ICollection, IEnumerable, ICloneable, INotifiesOnChange where TValue : class
Type Parameters
- TValue
- Value type. Must be a reference type.
Members
| All Members | Constructors | Properties | Methods | Events |
| Member | Description | |
|---|---|---|
| MetadataCollection<(Of <(<'TValue>)>)>()()()() | Creates an empty MetadataCollection. | |
| MetadataCollection<(Of <(<'TValue>)>)>(MetadataCollection<(Of <<'(TValue>)>>)) | Creates a copy of the given MetadataCollection. Copies all entries within. | |
| Add(MetadataEntry<(Of <<'(TValue>)>>)) | ||
| Add(String, String, TValue) | Adds a new entry to the collection.
Throws ArgumentException if an entry with the same group/key already exists. | |
| Changed | ||
| Clear()()()() | ||
| Clone()()()() | ||
| Contains(MetadataEntry<(Of <<'(TValue>)>>)) | ||
| ContainsGroup(String) | ||
| ContainsKey(String, String) | ||
| ContainsValue(TValue) | ||
| ContainsValue(TValue, IEqualityComparer<(Of <<'(TValue>)>>)) | ||
| CopyTo(Array, Int32) | ||
| CopyTo(array<MetadataEntry<(Of <<'(TValue>)>>)>[]()[][], Int32) | ||
| Count | The total number of entries in this collection. | |
| Equals(Object) | (Inherited from Object.) | |
| Finalize()()()() |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) | |
| Get(String, String) | ||
| GetEnumerator()()()() | Enumerates all keys in this collection. | |
| GetGroup(String) | Enumerates a group of keys. | |
| GetHashCode()()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) | |
| GetKeyCount(String) | Number of keys within a given group. Throws KeyNotFoundException if no such group exists. | |
| GetType()()()() |
Gets the Type of the current instance.
(Inherited from Object.) | |
| GroupCount | Number of groups in this collection. | |
| IsSynchronized | ||
| Item[([( String, String])]) | Gets or sets the value of a given entry.
If the specified key/value pair is not found, a get operation throws a KeyNotFoundException,
and a set operation creates a new element with the specified group/key. | |
| JoinToString<(Of <<'(T>)>>)(IEnumerable<(Of <<'(T>)>>)) | Joins all items in a collection into one comma-separated string.
If the items are not strings, .ToString() is called on them. (Inherited from EnumerableUtil.) | |
| JoinToString<(Of <<'(T>)>>)(IEnumerable<(Of <<'(T>)>>), String) | Joins all items in a collection into one string separated with the given separator.
If the items are not strings, .ToString() is called on them. (Inherited from EnumerableUtil.) | |
| JoinToString<(Of <<'(T>)>>)(IEnumerable<(Of <<'(T>)>>), Func<(Of <<'(T, String>)>>)) | Joins all items in a collection into one string separated with the given separator.
A specified string conversion function is called on each item before contactenation. (Inherited from EnumerableUtil.) | |
| JoinToString<(Of <<'(T>)>>)(IEnumerable<(Of <<'(T>)>>), String, Func<(Of <<'(T, String>)>>)) | Joins all items in a collection into one string separated with the given separator.
A specified string conversion function is called on each item before contactenation. (Inherited from EnumerableUtil.) | |
| MemberwiseClone()()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) | |
| Remove(MetadataEntry<(Of <<'(TValue>)>>)) | ||
| Remove(String, String) | Removes entry with the specified group/key from the collection. | |
| Set(MetadataEntry<(Of <<'(TValue>)>>)) | ||
| SyncRoot | Internal lock object used by this collection to ensure thread safety. | |
| ToString()()()() | (Inherited from Object.) | |
| TryGetValue(String, String, TValue%) |